@warmhub/sdk-ts 0.114.0 → 0.116.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/dist/index.d.ts CHANGED
@@ -140,6 +140,11 @@ type CommitRealOperationResult$1 = {
140
140
  message: string;
141
141
  removalMilestone: string;
142
142
  }>;
143
+ ignoredVersionPins?: Array<{
144
+ fieldPath: string;
145
+ wref: string;
146
+ binding: 'identity';
147
+ }>;
143
148
  };
144
149
  affirmations?: {
145
150
  added: Array<string>;
@@ -171,6 +176,11 @@ type CommitRealOperationResult$1 = {
171
176
  message: string;
172
177
  removalMilestone: string;
173
178
  }>;
179
+ ignoredVersionPins?: Array<{
180
+ fieldPath: string;
181
+ wref: string;
182
+ binding: 'identity';
183
+ }>;
174
184
  };
175
185
  affirmations?: {
176
186
  added: Array<string>;
@@ -383,6 +393,11 @@ type CommitValidateResult$1 = {
383
393
  message: string;
384
394
  removalMilestone: string;
385
395
  }>;
396
+ ignoredVersionPins?: Array<{
397
+ fieldPath: string;
398
+ wref: string;
399
+ binding: 'identity';
400
+ }>;
386
401
  };
387
402
  affirmations?: {
388
403
  added: Array<string>;
@@ -413,6 +428,11 @@ type CommitValidateResult$1 = {
413
428
  message: string;
414
429
  removalMilestone: string;
415
430
  }>;
431
+ ignoredVersionPins?: Array<{
432
+ fieldPath: string;
433
+ wref: string;
434
+ binding: 'identity';
435
+ }>;
416
436
  };
417
437
  affirmations?: {
418
438
  added: Array<string>;
@@ -443,6 +463,11 @@ type CommitValidateResult$1 = {
443
463
  message: string;
444
464
  removalMilestone: string;
445
465
  }>;
466
+ ignoredVersionPins?: Array<{
467
+ fieldPath: string;
468
+ wref: string;
469
+ binding: 'identity';
470
+ }>;
446
471
  };
447
472
  affirmations?: {
448
473
  added: Array<string>;
@@ -503,6 +528,11 @@ type CommitValidateResult$1 = {
503
528
  message: string;
504
529
  removalMilestone: string;
505
530
  }>;
531
+ ignoredVersionPins?: Array<{
532
+ fieldPath: string;
533
+ wref: string;
534
+ binding: 'identity';
535
+ }>;
506
536
  };
507
537
  affirmations?: {
508
538
  added: Array<string>;
@@ -534,6 +564,11 @@ type CommitValidateResult$1 = {
534
564
  message: string;
535
565
  removalMilestone: string;
536
566
  }>;
567
+ ignoredVersionPins?: Array<{
568
+ fieldPath: string;
569
+ wref: string;
570
+ binding: 'identity';
571
+ }>;
537
572
  };
538
573
  affirmations?: {
539
574
  added: Array<string>;
@@ -594,6 +629,11 @@ type CommitValidateResult$1 = {
594
629
  message: string;
595
630
  removalMilestone: string;
596
631
  }>;
632
+ ignoredVersionPins?: Array<{
633
+ fieldPath: string;
634
+ wref: string;
635
+ binding: 'identity';
636
+ }>;
597
637
  };
598
638
  affirmations?: {
599
639
  added: Array<string>;
@@ -624,6 +664,11 @@ type CommitValidateResult$1 = {
624
664
  message: string;
625
665
  removalMilestone: string;
626
666
  }>;
667
+ ignoredVersionPins?: Array<{
668
+ fieldPath: string;
669
+ wref: string;
670
+ binding: 'identity';
671
+ }>;
627
672
  };
628
673
  affirmations?: {
629
674
  added: Array<string>;
@@ -684,6 +729,11 @@ type CommitValidateResult$1 = {
684
729
  message: string;
685
730
  removalMilestone: string;
686
731
  }>;
732
+ ignoredVersionPins?: Array<{
733
+ fieldPath: string;
734
+ wref: string;
735
+ binding: 'identity';
736
+ }>;
687
737
  };
688
738
  affirmations?: {
689
739
  added: Array<string>;
@@ -730,6 +780,11 @@ type OperationEventReceipt$1 = {
730
780
  }>;
731
781
  coalescedWrefsTruncated?: true;
732
782
  totalCoalescedWrefs?: number;
783
+ ignoredVersionPins?: Array<{
784
+ fieldPath: string;
785
+ wref: string;
786
+ binding: 'identity';
787
+ }>;
733
788
  deprecations?: Array<{
734
789
  shape: string;
735
790
  message: string;
@@ -782,6 +837,11 @@ type OperationEventReceipt$1 = {
782
837
  }>;
783
838
  coalescedWrefsTruncated?: true;
784
839
  totalCoalescedWrefs?: number;
840
+ ignoredVersionPins?: Array<{
841
+ fieldPath: string;
842
+ wref: string;
843
+ binding: 'identity';
844
+ }>;
785
845
  deprecations?: Array<{
786
846
  shape: string;
787
847
  message: string;
@@ -832,6 +892,11 @@ type OperationEventReceipt$1 = {
832
892
  message: string;
833
893
  removalMilestone: string;
834
894
  }>;
895
+ ignoredVersionPins?: Array<{
896
+ fieldPath: string;
897
+ wref: string;
898
+ binding: 'identity';
899
+ }>;
835
900
  };
836
901
  affirmations?: {
837
902
  added: Array<string>;
@@ -863,6 +928,11 @@ type OperationEventReceipt$1 = {
863
928
  message: string;
864
929
  removalMilestone: string;
865
930
  }>;
931
+ ignoredVersionPins?: Array<{
932
+ fieldPath: string;
933
+ wref: string;
934
+ binding: 'identity';
935
+ }>;
866
936
  };
867
937
  affirmations?: {
868
938
  added: Array<string>;
@@ -944,6 +1014,11 @@ type OperationEventReceiptV1$1 = {
944
1014
  }>;
945
1015
  coalescedWrefsTruncated?: true;
946
1016
  totalCoalescedWrefs?: number;
1017
+ ignoredVersionPins?: Array<{
1018
+ fieldPath: string;
1019
+ wref: string;
1020
+ binding: 'identity';
1021
+ }>;
947
1022
  deprecations?: Array<{
948
1023
  shape: string;
949
1024
  message: string;
@@ -996,6 +1071,11 @@ type OperationEventReceiptV1$1 = {
996
1071
  }>;
997
1072
  coalescedWrefsTruncated?: true;
998
1073
  totalCoalescedWrefs?: number;
1074
+ ignoredVersionPins?: Array<{
1075
+ fieldPath: string;
1076
+ wref: string;
1077
+ binding: 'identity';
1078
+ }>;
999
1079
  deprecations?: Array<{
1000
1080
  shape: string;
1001
1081
  message: string;
@@ -1116,6 +1196,8 @@ type ComponentDetail = {
1116
1196
  name: string;
1117
1197
  kind: 'shape' | 'thing' | 'assertion' | 'collection';
1118
1198
  shapeName?: string;
1199
+ declaredShapes?: Array<string>;
1200
+ validatedShapes?: Array<string>;
1119
1201
  componentRef?: string;
1120
1202
  version: number;
1121
1203
  createdAt: number;
@@ -1183,6 +1265,11 @@ type ComponentInstallResult$1 = {
1183
1265
  }>;
1184
1266
  coalescedWrefsTruncated?: true;
1185
1267
  totalCoalescedWrefs?: number;
1268
+ ignoredVersionPins?: Array<{
1269
+ fieldPath: string;
1270
+ wref: string;
1271
+ binding: 'identity';
1272
+ }>;
1186
1273
  deprecations?: Array<{
1187
1274
  shape: string;
1188
1275
  message: string;
@@ -1235,6 +1322,11 @@ type ComponentInstallResult$1 = {
1235
1322
  }>;
1236
1323
  coalescedWrefsTruncated?: true;
1237
1324
  totalCoalescedWrefs?: number;
1325
+ ignoredVersionPins?: Array<{
1326
+ fieldPath: string;
1327
+ wref: string;
1328
+ binding: 'identity';
1329
+ }>;
1238
1330
  deprecations?: Array<{
1239
1331
  shape: string;
1240
1332
  message: string;
@@ -1285,6 +1377,11 @@ type ComponentInstallResult$1 = {
1285
1377
  message: string;
1286
1378
  removalMilestone: string;
1287
1379
  }>;
1380
+ ignoredVersionPins?: Array<{
1381
+ fieldPath: string;
1382
+ wref: string;
1383
+ binding: 'identity';
1384
+ }>;
1288
1385
  };
1289
1386
  affirmations?: {
1290
1387
  added: Array<string>;
@@ -1316,6 +1413,11 @@ type ComponentInstallResult$1 = {
1316
1413
  message: string;
1317
1414
  removalMilestone: string;
1318
1415
  }>;
1416
+ ignoredVersionPins?: Array<{
1417
+ fieldPath: string;
1418
+ wref: string;
1419
+ binding: 'identity';
1420
+ }>;
1319
1421
  };
1320
1422
  affirmations?: {
1321
1423
  added: Array<string>;
@@ -1441,6 +1543,11 @@ type ComponentUninstallResult$1 = {
1441
1543
  }>;
1442
1544
  coalescedWrefsTruncated?: true;
1443
1545
  totalCoalescedWrefs?: number;
1546
+ ignoredVersionPins?: Array<{
1547
+ fieldPath: string;
1548
+ wref: string;
1549
+ binding: 'identity';
1550
+ }>;
1444
1551
  deprecations?: Array<{
1445
1552
  shape: string;
1446
1553
  message: string;
@@ -1493,6 +1600,11 @@ type ComponentUninstallResult$1 = {
1493
1600
  }>;
1494
1601
  coalescedWrefsTruncated?: true;
1495
1602
  totalCoalescedWrefs?: number;
1603
+ ignoredVersionPins?: Array<{
1604
+ fieldPath: string;
1605
+ wref: string;
1606
+ binding: 'identity';
1607
+ }>;
1496
1608
  deprecations?: Array<{
1497
1609
  shape: string;
1498
1610
  message: string;
@@ -1543,6 +1655,11 @@ type ComponentUninstallResult$1 = {
1543
1655
  message: string;
1544
1656
  removalMilestone: string;
1545
1657
  }>;
1658
+ ignoredVersionPins?: Array<{
1659
+ fieldPath: string;
1660
+ wref: string;
1661
+ binding: 'identity';
1662
+ }>;
1546
1663
  };
1547
1664
  affirmations?: {
1548
1665
  added: Array<string>;
@@ -1574,6 +1691,11 @@ type ComponentUninstallResult$1 = {
1574
1691
  message: string;
1575
1692
  removalMilestone: string;
1576
1693
  }>;
1694
+ ignoredVersionPins?: Array<{
1695
+ fieldPath: string;
1696
+ wref: string;
1697
+ binding: 'identity';
1698
+ }>;
1577
1699
  };
1578
1700
  affirmations?: {
1579
1701
  added: Array<string>;
@@ -1657,6 +1779,14 @@ type GrantCreateInput = {
1657
1779
  componentName: string;
1658
1780
  };
1659
1781
  coverage?: {
1782
+ paths: {
1783
+ include: Array<string>;
1784
+ exclude?: Array<string>;
1785
+ };
1786
+ shapes?: Array<string>;
1787
+ shapeless?: boolean;
1788
+ fields?: Array<string>;
1789
+ } | {
1660
1790
  include: Array<string>;
1661
1791
  exclude?: Array<string>;
1662
1792
  };
@@ -1683,8 +1813,13 @@ type GrantListResult$1 = {
1683
1813
  idempotencyKey: string;
1684
1814
  requestHash: string;
1685
1815
  coverage: {
1686
- include: Array<string>;
1687
- exclude?: Array<string>;
1816
+ paths: {
1817
+ include: Array<string>;
1818
+ exclude?: Array<string>;
1819
+ };
1820
+ shapes?: Array<string>;
1821
+ shapeless?: boolean;
1822
+ fields?: Array<string>;
1688
1823
  } | null;
1689
1824
  viewRef: string | null;
1690
1825
  ops: Array<string>;
@@ -1713,8 +1848,13 @@ type GrantView = {
1713
1848
  idempotencyKey: string;
1714
1849
  requestHash: string;
1715
1850
  coverage: {
1716
- include: Array<string>;
1717
- exclude?: Array<string>;
1851
+ paths: {
1852
+ include: Array<string>;
1853
+ exclude?: Array<string>;
1854
+ };
1855
+ shapes?: Array<string>;
1856
+ shapeless?: boolean;
1857
+ fields?: Array<string>;
1718
1858
  } | null;
1719
1859
  viewRef: string | null;
1720
1860
  ops: Array<string>;
@@ -1901,6 +2041,11 @@ type StreamAppendResult$1 = {
1901
2041
  }>;
1902
2042
  coalescedWrefsTruncated?: true;
1903
2043
  totalCoalescedWrefs?: number;
2044
+ ignoredVersionPins?: Array<{
2045
+ fieldPath: string;
2046
+ wref: string;
2047
+ binding: 'identity';
2048
+ }>;
1904
2049
  deprecations?: Array<{
1905
2050
  shape: string;
1906
2051
  message: string;
@@ -1953,6 +2098,11 @@ type StreamAppendResult$1 = {
1953
2098
  }>;
1954
2099
  coalescedWrefsTruncated?: true;
1955
2100
  totalCoalescedWrefs?: number;
2101
+ ignoredVersionPins?: Array<{
2102
+ fieldPath: string;
2103
+ wref: string;
2104
+ binding: 'identity';
2105
+ }>;
1956
2106
  deprecations?: Array<{
1957
2107
  shape: string;
1958
2108
  message: string;
@@ -2019,6 +2169,11 @@ type StreamAppendResult$1 = {
2019
2169
  }>;
2020
2170
  coalescedWrefsTruncated?: true;
2021
2171
  totalCoalescedWrefs?: number;
2172
+ ignoredVersionPins?: Array<{
2173
+ fieldPath: string;
2174
+ wref: string;
2175
+ binding: 'identity';
2176
+ }>;
2022
2177
  deprecations?: Array<{
2023
2178
  shape: string;
2024
2179
  message: string;
@@ -2091,6 +2246,11 @@ type StreamAppendResult$1 = {
2091
2246
  }>;
2092
2247
  coalescedWrefsTruncated?: true;
2093
2248
  totalCoalescedWrefs?: number;
2249
+ ignoredVersionPins?: Array<{
2250
+ fieldPath: string;
2251
+ wref: string;
2252
+ binding: 'identity';
2253
+ }>;
2094
2254
  deprecations?: Array<{
2095
2255
  shape: string;
2096
2256
  message: string;
@@ -2143,6 +2303,11 @@ type StreamAppendResult$1 = {
2143
2303
  }>;
2144
2304
  coalescedWrefsTruncated?: true;
2145
2305
  totalCoalescedWrefs?: number;
2306
+ ignoredVersionPins?: Array<{
2307
+ fieldPath: string;
2308
+ wref: string;
2309
+ binding: 'identity';
2310
+ }>;
2146
2311
  deprecations?: Array<{
2147
2312
  shape: string;
2148
2313
  message: string;
@@ -2194,6 +2359,11 @@ type StreamAppendResult$1 = {
2194
2359
  message: string;
2195
2360
  removalMilestone: string;
2196
2361
  }>;
2362
+ ignoredVersionPins?: Array<{
2363
+ fieldPath: string;
2364
+ wref: string;
2365
+ binding: 'identity';
2366
+ }>;
2197
2367
  };
2198
2368
  affirmations?: {
2199
2369
  added: Array<string>;
@@ -2225,6 +2395,11 @@ type StreamAppendResult$1 = {
2225
2395
  message: string;
2226
2396
  removalMilestone: string;
2227
2397
  }>;
2398
+ ignoredVersionPins?: Array<{
2399
+ fieldPath: string;
2400
+ wref: string;
2401
+ binding: 'identity';
2402
+ }>;
2228
2403
  };
2229
2404
  affirmations?: {
2230
2405
  added: Array<string>;
@@ -2296,6 +2471,11 @@ type StreamAppendResult$1 = {
2296
2471
  message: string;
2297
2472
  removalMilestone: string;
2298
2473
  }>;
2474
+ ignoredVersionPins?: Array<{
2475
+ fieldPath: string;
2476
+ wref: string;
2477
+ binding: 'identity';
2478
+ }>;
2299
2479
  };
2300
2480
  affirmations?: {
2301
2481
  added: Array<string>;
@@ -2327,6 +2507,11 @@ type StreamAppendResult$1 = {
2327
2507
  message: string;
2328
2508
  removalMilestone: string;
2329
2509
  }>;
2510
+ ignoredVersionPins?: Array<{
2511
+ fieldPath: string;
2512
+ wref: string;
2513
+ binding: 'identity';
2514
+ }>;
2330
2515
  };
2331
2516
  affirmations?: {
2332
2517
  added: Array<string>;
@@ -2427,6 +2612,11 @@ type StreamAppendResult$1 = {
2427
2612
  message: string;
2428
2613
  removalMilestone: string;
2429
2614
  }>;
2615
+ ignoredVersionPins?: Array<{
2616
+ fieldPath: string;
2617
+ wref: string;
2618
+ binding: 'identity';
2619
+ }>;
2430
2620
  };
2431
2621
  affirmations?: {
2432
2622
  added: Array<string>;
@@ -2458,6 +2648,11 @@ type StreamAppendResult$1 = {
2458
2648
  message: string;
2459
2649
  removalMilestone: string;
2460
2650
  }>;
2651
+ ignoredVersionPins?: Array<{
2652
+ fieldPath: string;
2653
+ wref: string;
2654
+ binding: 'identity';
2655
+ }>;
2461
2656
  };
2462
2657
  affirmations?: {
2463
2658
  added: Array<string>;
@@ -2551,6 +2746,11 @@ type StreamingSubmissionRow$1 = {
2551
2746
  }>;
2552
2747
  coalescedWrefsTruncated?: true;
2553
2748
  totalCoalescedWrefs?: number;
2749
+ ignoredVersionPins?: Array<{
2750
+ fieldPath: string;
2751
+ wref: string;
2752
+ binding: 'identity';
2753
+ }>;
2554
2754
  deprecations?: Array<{
2555
2755
  shape: string;
2556
2756
  message: string;
@@ -2587,6 +2787,11 @@ type StreamingSubmissionRow$1 = {
2587
2787
  message: string;
2588
2788
  removalMilestone: string;
2589
2789
  }>;
2790
+ ignoredVersionPins?: Array<{
2791
+ fieldPath: string;
2792
+ wref: string;
2793
+ binding: 'identity';
2794
+ }>;
2590
2795
  };
2591
2796
  affirmations?: {
2592
2797
  added: Array<string>;
@@ -2621,6 +2826,11 @@ type StreamingSubmissionRow$1 = {
2621
2826
  message: string;
2622
2827
  removalMilestone: string;
2623
2828
  }>;
2829
+ ignoredVersionPins?: Array<{
2830
+ fieldPath: string;
2831
+ wref: string;
2832
+ binding: 'identity';
2833
+ }>;
2624
2834
  };
2625
2835
  affirmations?: {
2626
2836
  added: Array<string>;
@@ -2752,6 +2962,11 @@ type CommitApplyCompatibilityResult$1 = {
2752
2962
  }>;
2753
2963
  coalescedWrefsTruncated?: true;
2754
2964
  totalCoalescedWrefs?: number;
2965
+ ignoredVersionPins?: Array<{
2966
+ fieldPath: string;
2967
+ wref: string;
2968
+ binding: 'identity';
2969
+ }>;
2755
2970
  deprecations?: Array<{
2756
2971
  shape: string;
2757
2972
  message: string;
@@ -2794,6 +3009,11 @@ type CommitApplyCompatibilityResult$1 = {
2794
3009
  }>;
2795
3010
  coalescedWrefsTruncated?: true;
2796
3011
  totalCoalescedWrefs?: number;
3012
+ ignoredVersionPins?: Array<{
3013
+ fieldPath: string;
3014
+ wref: string;
3015
+ binding: 'identity';
3016
+ }>;
2797
3017
  deprecations?: Array<{
2798
3018
  shape: string;
2799
3019
  message: string;
@@ -2846,6 +3066,11 @@ type CommitApplyCompatibilityResult$1 = {
2846
3066
  }>;
2847
3067
  coalescedWrefsTruncated?: true;
2848
3068
  totalCoalescedWrefs?: number;
3069
+ ignoredVersionPins?: Array<{
3070
+ fieldPath: string;
3071
+ wref: string;
3072
+ binding: 'identity';
3073
+ }>;
2849
3074
  deprecations?: Array<{
2850
3075
  shape: string;
2851
3076
  message: string;
@@ -2906,6 +3131,11 @@ type CommitApplyCompatibilityResult$1 = {
2906
3131
  message: string;
2907
3132
  removalMilestone: string;
2908
3133
  }>;
3134
+ ignoredVersionPins?: Array<{
3135
+ fieldPath: string;
3136
+ wref: string;
3137
+ binding: 'identity';
3138
+ }>;
2909
3139
  };
2910
3140
  affirmations?: {
2911
3141
  added: Array<string>;
@@ -2937,6 +3167,11 @@ type CommitApplyCompatibilityResult$1 = {
2937
3167
  message: string;
2938
3168
  removalMilestone: string;
2939
3169
  }>;
3170
+ ignoredVersionPins?: Array<{
3171
+ fieldPath: string;
3172
+ wref: string;
3173
+ binding: 'identity';
3174
+ }>;
2940
3175
  };
2941
3176
  affirmations?: {
2942
3177
  added: Array<string>;
@@ -3012,6 +3247,11 @@ type CommitApplyCompatibilityResult$1 = {
3012
3247
  message: string;
3013
3248
  removalMilestone: string;
3014
3249
  }>;
3250
+ ignoredVersionPins?: Array<{
3251
+ fieldPath: string;
3252
+ wref: string;
3253
+ binding: 'identity';
3254
+ }>;
3015
3255
  };
3016
3256
  affirmations?: {
3017
3257
  added: Array<string>;
@@ -3043,6 +3283,11 @@ type CommitApplyCompatibilityResult$1 = {
3043
3283
  message: string;
3044
3284
  removalMilestone: string;
3045
3285
  }>;
3286
+ ignoredVersionPins?: Array<{
3287
+ fieldPath: string;
3288
+ wref: string;
3289
+ binding: 'identity';
3290
+ }>;
3046
3291
  };
3047
3292
  affirmations?: {
3048
3293
  added: Array<string>;
@@ -3125,6 +3370,11 @@ type CollectionMutationCompatibilityResult = {
3125
3370
  }>;
3126
3371
  coalescedWrefsTruncated?: true;
3127
3372
  totalCoalescedWrefs?: number;
3373
+ ignoredVersionPins?: Array<{
3374
+ fieldPath: string;
3375
+ wref: string;
3376
+ binding: 'identity';
3377
+ }>;
3128
3378
  deprecations?: Array<{
3129
3379
  shape: string;
3130
3380
  message: string;
@@ -3177,6 +3427,11 @@ type CollectionMutationCompatibilityResult = {
3177
3427
  }>;
3178
3428
  coalescedWrefsTruncated?: true;
3179
3429
  totalCoalescedWrefs?: number;
3430
+ ignoredVersionPins?: Array<{
3431
+ fieldPath: string;
3432
+ wref: string;
3433
+ binding: 'identity';
3434
+ }>;
3180
3435
  deprecations?: Array<{
3181
3436
  shape: string;
3182
3437
  message: string;
@@ -3216,6 +3471,11 @@ type CollectionMutationCompatibilityResult = {
3216
3471
  message: string;
3217
3472
  removalMilestone: string;
3218
3473
  }>;
3474
+ ignoredVersionPins?: Array<{
3475
+ fieldPath: string;
3476
+ wref: string;
3477
+ binding: 'identity';
3478
+ }>;
3219
3479
  };
3220
3480
  receipt: {
3221
3481
  event: {
@@ -3252,6 +3512,11 @@ type CollectionMutationCompatibilityResult = {
3252
3512
  }>;
3253
3513
  coalescedWrefsTruncated?: true;
3254
3514
  totalCoalescedWrefs?: number;
3515
+ ignoredVersionPins?: Array<{
3516
+ fieldPath: string;
3517
+ wref: string;
3518
+ binding: 'identity';
3519
+ }>;
3255
3520
  deprecations?: Array<{
3256
3521
  shape: string;
3257
3522
  message: string;
@@ -3304,6 +3569,11 @@ type CollectionMutationCompatibilityResult = {
3304
3569
  }>;
3305
3570
  coalescedWrefsTruncated?: true;
3306
3571
  totalCoalescedWrefs?: number;
3572
+ ignoredVersionPins?: Array<{
3573
+ fieldPath: string;
3574
+ wref: string;
3575
+ binding: 'identity';
3576
+ }>;
3307
3577
  deprecations?: Array<{
3308
3578
  shape: string;
3309
3579
  message: string;
@@ -3355,6 +3625,11 @@ type CollectionMutationCompatibilityResult = {
3355
3625
  message: string;
3356
3626
  removalMilestone: string;
3357
3627
  }>;
3628
+ ignoredVersionPins?: Array<{
3629
+ fieldPath: string;
3630
+ wref: string;
3631
+ binding: 'identity';
3632
+ }>;
3358
3633
  };
3359
3634
  affirmations?: {
3360
3635
  added: Array<string>;
@@ -3386,6 +3661,11 @@ type CollectionMutationCompatibilityResult = {
3386
3661
  message: string;
3387
3662
  removalMilestone: string;
3388
3663
  }>;
3664
+ ignoredVersionPins?: Array<{
3665
+ fieldPath: string;
3666
+ wref: string;
3667
+ binding: 'identity';
3668
+ }>;
3389
3669
  };
3390
3670
  affirmations?: {
3391
3671
  added: Array<string>;
@@ -3454,6 +3734,11 @@ type CollectionMutationCompatibilityResult = {
3454
3734
  message: string;
3455
3735
  removalMilestone: string;
3456
3736
  }>;
3737
+ ignoredVersionPins?: Array<{
3738
+ fieldPath: string;
3739
+ wref: string;
3740
+ binding: 'identity';
3741
+ }>;
3457
3742
  };
3458
3743
  receipt: {
3459
3744
  event: {
@@ -3489,6 +3774,11 @@ type CollectionMutationCompatibilityResult = {
3489
3774
  message: string;
3490
3775
  removalMilestone: string;
3491
3776
  }>;
3777
+ ignoredVersionPins?: Array<{
3778
+ fieldPath: string;
3779
+ wref: string;
3780
+ binding: 'identity';
3781
+ }>;
3492
3782
  };
3493
3783
  affirmations?: {
3494
3784
  added: Array<string>;
@@ -3520,6 +3810,11 @@ type CollectionMutationCompatibilityResult = {
3520
3810
  message: string;
3521
3811
  removalMilestone: string;
3522
3812
  }>;
3813
+ ignoredVersionPins?: Array<{
3814
+ fieldPath: string;
3815
+ wref: string;
3816
+ binding: 'identity';
3817
+ }>;
3523
3818
  };
3524
3819
  affirmations?: {
3525
3820
  added: Array<string>;
@@ -3602,6 +3897,11 @@ type RenameCompatibilityResult = {
3602
3897
  }>;
3603
3898
  coalescedWrefsTruncated?: true;
3604
3899
  totalCoalescedWrefs?: number;
3900
+ ignoredVersionPins?: Array<{
3901
+ fieldPath: string;
3902
+ wref: string;
3903
+ binding: 'identity';
3904
+ }>;
3605
3905
  deprecations?: Array<{
3606
3906
  shape: string;
3607
3907
  message: string;
@@ -3654,6 +3954,11 @@ type RenameCompatibilityResult = {
3654
3954
  }>;
3655
3955
  coalescedWrefsTruncated?: true;
3656
3956
  totalCoalescedWrefs?: number;
3957
+ ignoredVersionPins?: Array<{
3958
+ fieldPath: string;
3959
+ wref: string;
3960
+ binding: 'identity';
3961
+ }>;
3657
3962
  deprecations?: Array<{
3658
3963
  shape: string;
3659
3964
  message: string;
@@ -3706,6 +4011,11 @@ type RenameCompatibilityResult = {
3706
4011
  }>;
3707
4012
  coalescedWrefsTruncated?: true;
3708
4013
  totalCoalescedWrefs?: number;
4014
+ ignoredVersionPins?: Array<{
4015
+ fieldPath: string;
4016
+ wref: string;
4017
+ binding: 'identity';
4018
+ }>;
3709
4019
  deprecations?: Array<{
3710
4020
  shape: string;
3711
4021
  message: string;
@@ -3758,6 +4068,11 @@ type RenameCompatibilityResult = {
3758
4068
  }>;
3759
4069
  coalescedWrefsTruncated?: true;
3760
4070
  totalCoalescedWrefs?: number;
4071
+ ignoredVersionPins?: Array<{
4072
+ fieldPath: string;
4073
+ wref: string;
4074
+ binding: 'identity';
4075
+ }>;
3761
4076
  deprecations?: Array<{
3762
4077
  shape: string;
3763
4078
  message: string;
@@ -3809,6 +4124,11 @@ type RenameCompatibilityResult = {
3809
4124
  message: string;
3810
4125
  removalMilestone: string;
3811
4126
  }>;
4127
+ ignoredVersionPins?: Array<{
4128
+ fieldPath: string;
4129
+ wref: string;
4130
+ binding: 'identity';
4131
+ }>;
3812
4132
  };
3813
4133
  affirmations?: {
3814
4134
  added: Array<string>;
@@ -3840,6 +4160,11 @@ type RenameCompatibilityResult = {
3840
4160
  message: string;
3841
4161
  removalMilestone: string;
3842
4162
  }>;
4163
+ ignoredVersionPins?: Array<{
4164
+ fieldPath: string;
4165
+ wref: string;
4166
+ binding: 'identity';
4167
+ }>;
3843
4168
  };
3844
4169
  affirmations?: {
3845
4170
  added: Array<string>;
@@ -3920,6 +4245,11 @@ type RenameCompatibilityResult = {
3920
4245
  message: string;
3921
4246
  removalMilestone: string;
3922
4247
  }>;
4248
+ ignoredVersionPins?: Array<{
4249
+ fieldPath: string;
4250
+ wref: string;
4251
+ binding: 'identity';
4252
+ }>;
3923
4253
  };
3924
4254
  affirmations?: {
3925
4255
  added: Array<string>;
@@ -3951,6 +4281,11 @@ type RenameCompatibilityResult = {
3951
4281
  message: string;
3952
4282
  removalMilestone: string;
3953
4283
  }>;
4284
+ ignoredVersionPins?: Array<{
4285
+ fieldPath: string;
4286
+ wref: string;
4287
+ binding: 'identity';
4288
+ }>;
3954
4289
  };
3955
4290
  affirmations?: {
3956
4291
  added: Array<string>;
@@ -4033,6 +4368,11 @@ type ShapeChangeCompatibilityResult = {
4033
4368
  }>;
4034
4369
  coalescedWrefsTruncated?: true;
4035
4370
  totalCoalescedWrefs?: number;
4371
+ ignoredVersionPins?: Array<{
4372
+ fieldPath: string;
4373
+ wref: string;
4374
+ binding: 'identity';
4375
+ }>;
4036
4376
  deprecations?: Array<{
4037
4377
  shape: string;
4038
4378
  message: string;
@@ -4085,6 +4425,11 @@ type ShapeChangeCompatibilityResult = {
4085
4425
  }>;
4086
4426
  coalescedWrefsTruncated?: true;
4087
4427
  totalCoalescedWrefs?: number;
4428
+ ignoredVersionPins?: Array<{
4429
+ fieldPath: string;
4430
+ wref: string;
4431
+ binding: 'identity';
4432
+ }>;
4088
4433
  deprecations?: Array<{
4089
4434
  shape: string;
4090
4435
  message: string;
@@ -4140,6 +4485,11 @@ type ShapeChangeCompatibilityResult = {
4140
4485
  }>;
4141
4486
  coalescedWrefsTruncated?: true;
4142
4487
  totalCoalescedWrefs?: number;
4488
+ ignoredVersionPins?: Array<{
4489
+ fieldPath: string;
4490
+ wref: string;
4491
+ binding: 'identity';
4492
+ }>;
4143
4493
  deprecations?: Array<{
4144
4494
  shape: string;
4145
4495
  message: string;
@@ -4192,6 +4542,11 @@ type ShapeChangeCompatibilityResult = {
4192
4542
  }>;
4193
4543
  coalescedWrefsTruncated?: true;
4194
4544
  totalCoalescedWrefs?: number;
4545
+ ignoredVersionPins?: Array<{
4546
+ fieldPath: string;
4547
+ wref: string;
4548
+ binding: 'identity';
4549
+ }>;
4195
4550
  deprecations?: Array<{
4196
4551
  shape: string;
4197
4552
  message: string;
@@ -4243,6 +4598,11 @@ type ShapeChangeCompatibilityResult = {
4243
4598
  message: string;
4244
4599
  removalMilestone: string;
4245
4600
  }>;
4601
+ ignoredVersionPins?: Array<{
4602
+ fieldPath: string;
4603
+ wref: string;
4604
+ binding: 'identity';
4605
+ }>;
4246
4606
  };
4247
4607
  affirmations?: {
4248
4608
  added: Array<string>;
@@ -4274,6 +4634,11 @@ type ShapeChangeCompatibilityResult = {
4274
4634
  message: string;
4275
4635
  removalMilestone: string;
4276
4636
  }>;
4637
+ ignoredVersionPins?: Array<{
4638
+ fieldPath: string;
4639
+ wref: string;
4640
+ binding: 'identity';
4641
+ }>;
4277
4642
  };
4278
4643
  affirmations?: {
4279
4644
  added: Array<string>;
@@ -4357,6 +4722,11 @@ type ShapeChangeCompatibilityResult = {
4357
4722
  message: string;
4358
4723
  removalMilestone: string;
4359
4724
  }>;
4725
+ ignoredVersionPins?: Array<{
4726
+ fieldPath: string;
4727
+ wref: string;
4728
+ binding: 'identity';
4729
+ }>;
4360
4730
  };
4361
4731
  affirmations?: {
4362
4732
  added: Array<string>;
@@ -4388,6 +4758,11 @@ type ShapeChangeCompatibilityResult = {
4388
4758
  message: string;
4389
4759
  removalMilestone: string;
4390
4760
  }>;
4761
+ ignoredVersionPins?: Array<{
4762
+ fieldPath: string;
4763
+ wref: string;
4764
+ binding: 'identity';
4765
+ }>;
4391
4766
  };
4392
4767
  affirmations?: {
4393
4768
  added: Array<string>;
@@ -4470,6 +4845,11 @@ type ShapeRemoveCompatibilityResult = {
4470
4845
  }>;
4471
4846
  coalescedWrefsTruncated?: true;
4472
4847
  totalCoalescedWrefs?: number;
4848
+ ignoredVersionPins?: Array<{
4849
+ fieldPath: string;
4850
+ wref: string;
4851
+ binding: 'identity';
4852
+ }>;
4473
4853
  deprecations?: Array<{
4474
4854
  shape: string;
4475
4855
  message: string;
@@ -4522,6 +4902,11 @@ type ShapeRemoveCompatibilityResult = {
4522
4902
  }>;
4523
4903
  coalescedWrefsTruncated?: true;
4524
4904
  totalCoalescedWrefs?: number;
4905
+ ignoredVersionPins?: Array<{
4906
+ fieldPath: string;
4907
+ wref: string;
4908
+ binding: 'identity';
4909
+ }>;
4525
4910
  deprecations?: Array<{
4526
4911
  shape: string;
4527
4912
  message: string;
@@ -4578,6 +4963,11 @@ type ShapeRemoveCompatibilityResult = {
4578
4963
  }>;
4579
4964
  coalescedWrefsTruncated?: true;
4580
4965
  totalCoalescedWrefs?: number;
4966
+ ignoredVersionPins?: Array<{
4967
+ fieldPath: string;
4968
+ wref: string;
4969
+ binding: 'identity';
4970
+ }>;
4581
4971
  deprecations?: Array<{
4582
4972
  shape: string;
4583
4973
  message: string;
@@ -4630,6 +5020,11 @@ type ShapeRemoveCompatibilityResult = {
4630
5020
  }>;
4631
5021
  coalescedWrefsTruncated?: true;
4632
5022
  totalCoalescedWrefs?: number;
5023
+ ignoredVersionPins?: Array<{
5024
+ fieldPath: string;
5025
+ wref: string;
5026
+ binding: 'identity';
5027
+ }>;
4633
5028
  deprecations?: Array<{
4634
5029
  shape: string;
4635
5030
  message: string;
@@ -4681,6 +5076,11 @@ type ShapeRemoveCompatibilityResult = {
4681
5076
  message: string;
4682
5077
  removalMilestone: string;
4683
5078
  }>;
5079
+ ignoredVersionPins?: Array<{
5080
+ fieldPath: string;
5081
+ wref: string;
5082
+ binding: 'identity';
5083
+ }>;
4684
5084
  };
4685
5085
  affirmations?: {
4686
5086
  added: Array<string>;
@@ -4712,6 +5112,11 @@ type ShapeRemoveCompatibilityResult = {
4712
5112
  message: string;
4713
5113
  removalMilestone: string;
4714
5114
  }>;
5115
+ ignoredVersionPins?: Array<{
5116
+ fieldPath: string;
5117
+ wref: string;
5118
+ binding: 'identity';
5119
+ }>;
4715
5120
  };
4716
5121
  affirmations?: {
4717
5122
  added: Array<string>;
@@ -4796,6 +5201,11 @@ type ShapeRemoveCompatibilityResult = {
4796
5201
  message: string;
4797
5202
  removalMilestone: string;
4798
5203
  }>;
5204
+ ignoredVersionPins?: Array<{
5205
+ fieldPath: string;
5206
+ wref: string;
5207
+ binding: 'identity';
5208
+ }>;
4799
5209
  };
4800
5210
  affirmations?: {
4801
5211
  added: Array<string>;
@@ -4827,6 +5237,11 @@ type ShapeRemoveCompatibilityResult = {
4827
5237
  message: string;
4828
5238
  removalMilestone: string;
4829
5239
  }>;
5240
+ ignoredVersionPins?: Array<{
5241
+ fieldPath: string;
5242
+ wref: string;
5243
+ binding: 'identity';
5244
+ }>;
4830
5245
  };
4831
5246
  affirmations?: {
4832
5247
  added: Array<string>;
@@ -4913,6 +5328,7 @@ type RefsResult$1 = {
4913
5328
  shapeName?: string;
4914
5329
  version?: number;
4915
5330
  fieldPath?: string;
5331
+ binding?: 'identity' | 'versioned';
4916
5332
  }>;
4917
5333
  nextCursor?: string;
4918
5334
  };
@@ -4954,6 +5370,8 @@ type ThingHistoryResult = {
4954
5370
  thingName?: string;
4955
5371
  thingKind?: string;
4956
5372
  shapeName?: string;
5373
+ declaredShapes?: Array<string>;
5374
+ validatedShapes?: Array<string>;
4957
5375
  operation: 'add' | 'revise' | 'retract' | 'reaffirm';
4958
5376
  retractReason?: string;
4959
5377
  data?: unknown;
@@ -4980,6 +5398,8 @@ type ThingGetManyResult$1 = {
4980
5398
  shape?: string;
4981
5399
  shapeName?: string;
4982
5400
  validatedShape?: string;
5401
+ declaredShapes: Array<string>;
5402
+ validatedShapes: Array<string>;
4983
5403
  version: number;
4984
5404
  data?: unknown;
4985
5405
  collection?: {
@@ -5336,6 +5756,8 @@ type ViewEvaluateResult$1 = {
5336
5756
  name: string;
5337
5757
  kind: 'shape' | 'thing' | 'assertion' | 'collection';
5338
5758
  shapeName?: string;
5759
+ declaredShapes?: Array<string>;
5760
+ validatedShapes?: Array<string>;
5339
5761
  componentRef?: string;
5340
5762
  version: number;
5341
5763
  createdAt: number;
@@ -7666,6 +8088,43 @@ type IndexedFieldEntry = {
7666
8088
  backfillDone: number;
7667
8089
  backfillTotal: number | null;
7668
8090
  };
8091
+ /**
8092
+ * One shape's marker on a declared field path.
8093
+ * @see https://docs.warmhub.ai/sdk-reference/type-aliases/fieldindexcarryingmarker/
8094
+ */
8095
+ type FieldIndexCarryingMarker = {
8096
+ shapeName: string;
8097
+ /** Index states: building | ready | failed */
8098
+ state: string;
8099
+ };
8100
+ /**
8101
+ * One row of the declared-indexing registry, joined to the markers on it.
8102
+ * @see https://docs.warmhub.ai/sdk-reference/type-aliases/declaredfieldentry/
8103
+ */
8104
+ type DeclaredFieldEntry = {
8105
+ fieldPath: string;
8106
+ /** Shape named at pin time, display only; null once that shape is gone. */
8107
+ declaredByShape: string | null;
8108
+ /** Every shape carrying this path, one entry per marker. */
8109
+ carrying: FieldIndexCarryingMarker[];
8110
+ /** At least one marker carries the path and every one is ready. */
8111
+ ready: boolean;
8112
+ };
8113
+ /**
8114
+ * Declarations-versus-markers consistency check.
8115
+ * @see https://docs.warmhub.ai/sdk-reference/type-aliases/fieldindexconsistency/
8116
+ */
8117
+ type FieldIndexConsistency = {
8118
+ /** Markers indexing a path the registry does not authorize. */
8119
+ undeclaredMarkers: Array<{
8120
+ shapeName: string;
8121
+ fieldPath: string;
8122
+ }>;
8123
+ /** Declared paths no marker carries. Informational, not a mismatch. */
8124
+ uncarriedDeclarations: string[];
8125
+ /** No marker indexes a path the registry does not authorize. */
8126
+ consistent: boolean;
8127
+ };
7669
8128
  /**
7670
8129
  * Report of all indexed fields for a repo, grouped by state.
7671
8130
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/indexedfieldsreport/
@@ -7675,6 +8134,28 @@ type IndexedFieldsReport = {
7675
8134
  building: IndexedFieldEntry[];
7676
8135
  failed: IndexedFieldEntry[];
7677
8136
  other: IndexedFieldEntry[];
8137
+ /** The declarations that authorize those markers. */
8138
+ declarations: DeclaredFieldEntry[];
8139
+ consistency: FieldIndexConsistency;
8140
+ };
8141
+ /**
8142
+ * A shape whose contract carries a declared field path, and its marker state.
8143
+ * @see https://docs.warmhub.ai/sdk-reference/type-aliases/fieldindexcarryingshape/
8144
+ */
8145
+ type FieldIndexCarryingShape = {
8146
+ shape: string;
8147
+ markerState: string;
8148
+ };
8149
+ /**
8150
+ * Result of declaring (or withdrawing) a field path for indexing.
8151
+ * @see https://docs.warmhub.ai/sdk-reference/type-aliases/fieldindexpinresult/
8152
+ */
8153
+ type FieldIndexPinResult = {
8154
+ /** The path as the shape spells it — a case-insensitive request is folded to it. */
8155
+ fieldPath: string;
8156
+ /** The shape the caller named; display only, since a declaration is repo-wide. */
8157
+ declaredByShape: string;
8158
+ carryingShapes: FieldIndexCarryingShape[];
7678
8159
  };
7679
8160
  /** @internal */
7680
8161
  type ComponentInfo = ComponentSummary;
@@ -7800,11 +8281,15 @@ type ShapeGetOptions = {
7800
8281
  type ShapeCreateOptions = {
7801
8282
  eventRequestId: string;
7802
8283
  description?: string;
8284
+ /** Shape HEAD references captured as an immutable composition closure. */
8285
+ composes?: string[];
7803
8286
  };
7804
8287
  /** @internal */
7805
8288
  type ShapeReviseOptions = {
7806
8289
  eventRequestId: string;
7807
8290
  description?: string;
8291
+ /** Replace the composition list; omit to preserve it, or pass [] to clear it. */
8292
+ composes?: string[];
7808
8293
  };
7809
8294
  /** @internal */
7810
8295
  type ShapeRemoveOptions = {
@@ -8115,6 +8600,10 @@ type ThingItem = {
8115
8600
  name: string;
8116
8601
  kind: string;
8117
8602
  shapeName?: string;
8603
+ /** Version-pinned Shapes declared directly by this Thing version. */
8604
+ declaredShapes?: string[];
8605
+ /** Full certified closure, included only when requested on page reads. */
8606
+ validatedShapes?: string[];
8118
8607
  version: number;
8119
8608
  createdAt: number;
8120
8609
  active?: boolean;
@@ -8139,7 +8628,7 @@ type HeadResult = {
8139
8628
  repoSeq?: number;
8140
8629
  };
8141
8630
  /** @internal */
8142
- type ThingHeadChangesOptions = Omit<ThingHeadOptions, 'cursor' | 'includeRetracted' | 'sinceRepoSeq'> & {
8631
+ type ThingHeadChangesOptions = Omit<ThingHeadOptions, 'cursor' | 'includeRetracted' | 'sinceRepoSeq' | 'declaredShape' | 'includeValidatedShapes'> & {
8143
8632
  sinceRepoSeq: number;
8144
8633
  };
8145
8634
  /** @internal */
@@ -8217,6 +8706,10 @@ type ThingDetail = {
8217
8706
  * repository reads certificates.
8218
8707
  */
8219
8708
  validatedShape?: string;
8709
+ /** Version-pinned Shapes declared directly by this Thing version. */
8710
+ declaredShapes?: string[];
8711
+ /** Full version-pinned certificate closure for this Thing version. */
8712
+ validatedShapes?: string[];
8220
8713
  version: number;
8221
8714
  active: boolean;
8222
8715
  data?: unknown;
@@ -8288,6 +8781,8 @@ type ThingHeadRequest = {
8288
8781
  orgName: string;
8289
8782
  repoName: string;
8290
8783
  shape?: string;
8784
+ declaredShape?: string;
8785
+ includeValidatedShapes?: boolean;
8291
8786
  kind?: CommitOperationKind;
8292
8787
  match?: string;
8293
8788
  dataMode?: 'full' | 'summary' | 'none';
@@ -8380,6 +8875,7 @@ type ActionListNotificationsOptions = {
8380
8875
  type ThingHistoryOptions = {
8381
8876
  wref?: string;
8382
8877
  shape?: string;
8878
+ declaredShape?: string;
8383
8879
  about?: string;
8384
8880
  includeRetracted?: boolean;
8385
8881
  resolveCollections?: boolean;
@@ -8576,6 +9072,10 @@ type WherePredicate = (WherePredicateBase & {
8576
9072
  type FilterOptions = {
8577
9073
  /** Filter to records of this shape name (for example `Player`). */
8578
9074
  shape?: string;
9075
+ /** Filter to records that directly declare this Shape. */
9076
+ declaredShape?: string;
9077
+ /** Include the full certified Shape closure on each returned item. */
9078
+ includeValidatedShapes?: boolean;
8579
9079
  /**
8580
9080
  * Filter to records of this kind: `shape`, `thing`, `assertion`, or
8581
9081
  * `collection`. The requested kind controls membership: `thing` includes
@@ -8621,7 +9121,7 @@ type FilterOptions = {
8621
9121
  sinceRepoSeq?: number;
8622
9122
  };
8623
9123
  /** @internal */
8624
- type ThingQueryChangesOptions = Omit<FilterOptions, 'cursor' | 'includeRetracted' | 'sinceRepoSeq' | 'affirmedAbout'> & {
9124
+ type ThingQueryChangesOptions = Omit<FilterOptions, 'cursor' | 'includeRetracted' | 'sinceRepoSeq' | 'affirmedAbout' | 'declaredShape' | 'includeValidatedShapes'> & {
8625
9125
  sinceRepoSeq: number;
8626
9126
  };
8627
9127
  /**
@@ -8633,7 +9133,7 @@ type ThingQueryChangesOptions = Omit<FilterOptions, 'cursor' | 'includeRetracted
8633
9133
  *
8634
9134
  * @see https://docs.warmhub.ai/sdk/read-semantics/#search-modes
8635
9135
  */
8636
- type SearchOptions = Omit<FilterOptions, 'where' | 'role' | 'sinceRepoSeq'> & {
9136
+ type SearchOptions = Omit<FilterOptions, 'where' | 'role' | 'sinceRepoSeq' | 'declaredShape' | 'includeValidatedShapes'> & {
8637
9137
  /** Restrict the search to assertions about this wref target. */
8638
9138
  about?: string;
8639
9139
  /** Search mode: `text` (BM25), `vector` (semantic), or `hybrid` (combined). Defaults to `text`. */
@@ -8650,7 +9150,7 @@ type SearchOptions = Omit<FilterOptions, 'where' | 'role' | 'sinceRepoSeq'> & {
8650
9150
  * pagination fields (`limit`, `cursor`) are ignored.
8651
9151
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/countoptions/
8652
9152
  */
8653
- type CountOptions = Omit<FilterOptions, 'role'>;
9153
+ type CountOptions = Omit<FilterOptions, 'role' | 'limit' | 'cursor' | 'includeValidatedShapes'>;
8654
9154
  /**
8655
9155
  * Options for `client.thing.refs` — wref-field reverse and forward lookups.
8656
9156
  *
@@ -8661,6 +9161,12 @@ type RefsOptions = {
8661
9161
  direction?: 'inbound' | 'outbound';
8662
9162
  /** Narrow an inbound search to a specific wref field path on the source shape. */
8663
9163
  fieldPath?: string;
9164
+ /**
9165
+ * Keep only edges written under one binding mode: `identity` edges follow
9166
+ * the target Thing, `versioned` edges pin one version. Each returned item
9167
+ * also reports its own `binding`.
9168
+ */
9169
+ binding?: 'identity' | 'versioned';
8664
9170
  /** Maximum references returned per page. */
8665
9171
  limit?: number;
8666
9172
  /** Pagination cursor returned by the prior call. */
@@ -9688,6 +10194,21 @@ declare class WarmHubClient {
9688
10194
  * Use `wh repo describe --indexed-fields --repo <org/repo>`.
9689
10195
  */
9690
10196
  describe: (orgName: string, repoName: string) => Promise<IndexedFieldsReport>;
10197
+ /**
10198
+ * Declare a field path for indexing.
10199
+ *
10200
+ * The path is resolved through `shape`'s effective contract, so a
10201
+ * composite may name a property one of its composed shapes owns. The
10202
+ * declaration is repository-wide: every shape carrying the path is
10203
+ * backfilled, not just the one named here.
10204
+ */
10205
+ pin: (orgName: string, repoName: string, shape: string, fieldPath: string) => Promise<FieldIndexPinResult>;
10206
+ /**
10207
+ * Withdraw a field path's indexing declaration and evict its rows.
10208
+ *
10209
+ * Refuses while a stored View definition still references the path.
10210
+ */
10211
+ unpin: (orgName: string, repoName: string, shape: string, fieldPath: string) => Promise<FieldIndexPinResult>;
9691
10212
  };
9692
10213
  };
9693
10214
  /**
@@ -10757,4 +11278,4 @@ declare class WarmHubClient {
10757
11278
  private watchRepoQuery;
10758
11279
  }
10759
11280
 
10760
- export { type AboutOptions, type AboutResult, type AccessResolveInput, type AccessResolveResult, type AccessTokenProvider, type ActionAttemptInfo, type ActionDeliveryTarget, type ActionLeaseAcquire, type ActionLeaseOp, type ActionListNotificationsOptions, type ActionListRunsOptions, type ActionLiveFeed, type ActionLiveFeedItem, type ActionLiveFeedOptions, type ActionNotificationInfo, type ActionRunInfo, type ActionRunStatsInfo, type ActionRunStatsOptions, type AddOp, type AddOperation, AllStreamOperationsFailedError, type Assertion, CLI_INSTALL_REPO_HEADER, CLI_SIGNATURE_HEADER, CLI_TIMESTAMP_HEADER, CONTENT_FIELD_LIMIT_ERROR, type CliCallSecrets, CliCallVerificationError, type CliCallVerificationFailureReason, type CollectionAddOp, type CollectionAddType, type CollectionContainsOptions, type CollectionContainsResult, type CollectionCreateOptions, type CollectionDiffOptions, type CollectionDiffResult, type CollectionMember, type CollectionMembersOptions, type CollectionMembersPage, type CollectionMembershipRole, type CollectionMutationResult, type CollectionQuerySourceOptions, type CollectionReadDataMode, type CollectionReadSummary, type CollectionReviseOptions, type CollectionStatsOptions, type CollectionStatsResult, type CollectionTag, type CollectionType, type CommitApplyCompatibilityResult, type CommitDiagnostic, type CommitRealOperationResult, type CommitValidateInput, type CommitValidateOptions, type CommitValidateResult, type ComponentHistory, type ComponentHistoryOptions, type ComponentInfo, type ComponentInstallOptions, type ComponentInstallResult, type ComponentList, type ComponentListOptions, type ComponentUninstallOptions, type ComponentUninstallResult, type ComponentView, type CoreErrorKind, type CountOptions, type CountResult, type CredentialAuditEntry, type CredentialDeleteResult, type CredentialGrantResult, type CredentialInfo, type CredentialKeyMutationResult, type CredentialRevokeResult, type CredentialUngrantResult, type CurrentUserInfo, DEFAULT_API_URL, DEFAULT_STREAM_CHUNK_SIZE, type ErrorKind, type FilterOptions, type FilterResult, type FunctionLogMode, type GlobalSearchOptions, type GlobalSearchResult, type GlobalSearchResultItem, type Grant, type GrantCreateOptions, type GrantListOptions, type GrantListResult, type GrantRecipientSelector, type GrantRevokeResult, type HeadResult, type HistoryResult, type HistoryVersion, type HomepageFeaturedListsResult, type IndexedFieldEntry, type IndexedFieldsReport, type LiveHandle, type LiveRepoEvent, type LiveSubscriptionLogOptions, type LiveThingHeadOptions, type LiveThingHistoryOptions, type LiveWatchResult, MAX_COMMIT_VALIDATION_ENCODED_BYTES, MAX_COMMIT_VALIDATION_OPERATIONS, MAX_CONTENT_FIELD_BYTES, MAX_STREAM_APPEND_OPERATION_COUNT, ORG_AUTH_SCOPES, type Operation, OperationBuilder, type OperationBuilderAddInput, type OperationBuilderClient, type OperationBuilderOp, type OperationBuilderOptions, type OperationEventReceipt, type OperationEventReceiptV1, type OperationSource, type OperationSubmitResult, type OrgAccessResult, type OrgAuthScope, type OrgInfo, type OrgList, type OrgListMembersOptions, type OrgListOptions, type OrgMemberInfo, type OrgMemberList, type OrgRef, type OrgRole, type Page, type PageRequest, PartialStreamSubmissionError, type PingResult, REPO_AUTH_SCOPES, type ReaffirmOperation, type RefLink, type RefsOptions, type RefsResult, type RenameOperation, type RenameOptions, type RenameResult, type RepoAccessResult, type RepoAuthScope, type RepoConfigureStatsView, type RepoDescribeResult, type RepoExploreBrowseOptions, type RepoExploreItem, type RepoExploreOptions, type RepoExploreResult, type RepoInfo, type RepoLicense, type RepoList, type RepoListForCallerOptions, type RepoListOptions, type RepoListPageOptions, type RepoListPageResult, type RepoLocator, type RepoRecentInfo, type RepoRef, type RepoShapeInstanceCountsView, type RepoSort, type RepoStatsBatchResult, type RepoStatsView, type RepoWithStatsInfo, type RepositoryCheckpointAccess, type RepositoryCheckpointStatus, RepositoryExportError, type RepositoryExportErrorReason, type RepositoryExportExpectation, type RepositoryExportOptions, type RepositoryExportPreparation, type RepositoryExportPrepareOptions, type RepositoryExportRestoreOptions, type RepositoryExportRowMap, type RepositoryExportRows, type RepositoryExportSegmentOptions, RepositoryExportSession, type RequestEvent, type ResolveWrefResult, type RetractOp, type RetractOperation, type RetryPolicyOptions, type ReviseOp, type ReviseOperation, SDK_VERSION, type SearchOptions, type SearchResult, type Shape, type ShapeChange, type ShapeCreateOptions, type ShapeFields, type ShapeGetOptions, type ShapeHistory, type ShapeHistoryOptions, type ShapeList, type ShapeListOptions, type ShapeRef, type ShapeRemove, type ShapeRemoveOptions, type ShapeReviseOptions, type ShapeValidatorResult, type StreamAppendInput, type StreamAppendResult, type StreamContinuationState, StreamSubmissionAggregator, type StreamingSubmissionHandle, type StreamingSubmissionOptions, StreamingSubmissionOutcomeUnknownError, type StreamingSubmissionRetryIdentity, type StreamingSubmissionRow, type SubscriptionBindCredentialsResult, type SubscriptionCompatCreateInput, type SubscriptionCompatUpdateInput, type SubscriptionInfo, type SubscriptionList, type SubscriptionUnbindCredentialsResult, type SynthesizedRepoContent, type ThingChanges, type ThingDetail, type ThingGet, type ThingGetManyResult, type ThingGetOptions, type ThingGetWithLease, type ThingGraphOptions, type ThingGraphResult, type ThingGraphValue, type ThingHead, type ThingHeadChangesOptions, type ThingHeadOptions, type ThingHeadRequest, type ThingHeadVersionsResult, type ThingHistory, type ThingHistoryOptions, type ThingItem, type ThingMetadata, type ThingQueryChangesOptions, type TokenInfo, type TokenResult, type UndeclaredFieldsWarning, type ValidationDiagnostic, type ValidationResult, type VerifiedCliCall, type ViewEvaluateOptions, type ViewEvaluateResult, WarmHubClient, type WarmHubClientOptions, type WarmHubDecorations, WarmHubError, type WarmHubErrorDetails, type WherePredicate, type WhoamiInfo, type WhoamiScopeEntry, type WireScopeEntry, applyRepositoryExportDelta, collectDurableTokens, commitValidateRequestBodyBytes, connectionErrorMessage, contentFieldLimitError, countStreamAppendResultStatuses, createCommitValidateInput, createOperationEventRequestId, createOperationEventSubmissionId, createRepositoryExportSession, encodeCommitValidateRequestBody, getResponseDecorations, isConnectionError, isDefiniteStreamAppendRejection, isKnownOrgAuthScope, isKnownRepoAuthScope, isRetryable, isWarmHubError, normalizeWref, operationEventStreamRequestId, readRepositoryExportStream, resolveFunctionLogMode, restoreRepositoryExportSession, sanitizeErrorMessage, sdkVersionIsBelowMinimum, streamAppendResultStatus, submitOperationsViaStream, toWarmHubError, validateAgainstShape, verifyCliCall };
11281
+ export { type AboutOptions, type AboutResult, type AccessResolveInput, type AccessResolveResult, type AccessTokenProvider, type ActionAttemptInfo, type ActionDeliveryTarget, type ActionLeaseAcquire, type ActionLeaseOp, type ActionListNotificationsOptions, type ActionListRunsOptions, type ActionLiveFeed, type ActionLiveFeedItem, type ActionLiveFeedOptions, type ActionNotificationInfo, type ActionRunInfo, type ActionRunStatsInfo, type ActionRunStatsOptions, type AddOp, type AddOperation, AllStreamOperationsFailedError, type Assertion, CLI_INSTALL_REPO_HEADER, CLI_SIGNATURE_HEADER, CLI_TIMESTAMP_HEADER, CONTENT_FIELD_LIMIT_ERROR, type CliCallSecrets, CliCallVerificationError, type CliCallVerificationFailureReason, type CollectionAddOp, type CollectionAddType, type CollectionContainsOptions, type CollectionContainsResult, type CollectionCreateOptions, type CollectionDiffOptions, type CollectionDiffResult, type CollectionMember, type CollectionMembersOptions, type CollectionMembersPage, type CollectionMembershipRole, type CollectionMutationResult, type CollectionQuerySourceOptions, type CollectionReadDataMode, type CollectionReadSummary, type CollectionReviseOptions, type CollectionStatsOptions, type CollectionStatsResult, type CollectionTag, type CollectionType, type CommitApplyCompatibilityResult, type CommitDiagnostic, type CommitRealOperationResult, type CommitValidateInput, type CommitValidateOptions, type CommitValidateResult, type ComponentHistory, type ComponentHistoryOptions, type ComponentInfo, type ComponentInstallOptions, type ComponentInstallResult, type ComponentList, type ComponentListOptions, type ComponentUninstallOptions, type ComponentUninstallResult, type ComponentView, type CoreErrorKind, type CountOptions, type CountResult, type CredentialAuditEntry, type CredentialDeleteResult, type CredentialGrantResult, type CredentialInfo, type CredentialKeyMutationResult, type CredentialRevokeResult, type CredentialUngrantResult, type CurrentUserInfo, DEFAULT_API_URL, DEFAULT_STREAM_CHUNK_SIZE, type DeclaredFieldEntry, type ErrorKind, type FieldIndexCarryingMarker, type FieldIndexCarryingShape, type FieldIndexConsistency, type FieldIndexPinResult, type FilterOptions, type FilterResult, type FunctionLogMode, type GlobalSearchOptions, type GlobalSearchResult, type GlobalSearchResultItem, type Grant, type GrantCreateOptions, type GrantListOptions, type GrantListResult, type GrantRecipientSelector, type GrantRevokeResult, type HeadResult, type HistoryResult, type HistoryVersion, type HomepageFeaturedListsResult, type IndexedFieldEntry, type IndexedFieldsReport, type LiveHandle, type LiveRepoEvent, type LiveSubscriptionLogOptions, type LiveThingHeadOptions, type LiveThingHistoryOptions, type LiveWatchResult, MAX_COMMIT_VALIDATION_ENCODED_BYTES, MAX_COMMIT_VALIDATION_OPERATIONS, MAX_CONTENT_FIELD_BYTES, MAX_STREAM_APPEND_OPERATION_COUNT, ORG_AUTH_SCOPES, type Operation, OperationBuilder, type OperationBuilderAddInput, type OperationBuilderClient, type OperationBuilderOp, type OperationBuilderOptions, type OperationEventReceipt, type OperationEventReceiptV1, type OperationSource, type OperationSubmitResult, type OrgAccessResult, type OrgAuthScope, type OrgInfo, type OrgList, type OrgListMembersOptions, type OrgListOptions, type OrgMemberInfo, type OrgMemberList, type OrgRef, type OrgRole, type Page, type PageRequest, PartialStreamSubmissionError, type PingResult, REPO_AUTH_SCOPES, type ReaffirmOperation, type RefLink, type RefsOptions, type RefsResult, type RenameOperation, type RenameOptions, type RenameResult, type RepoAccessResult, type RepoAuthScope, type RepoConfigureStatsView, type RepoDescribeResult, type RepoExploreBrowseOptions, type RepoExploreItem, type RepoExploreOptions, type RepoExploreResult, type RepoInfo, type RepoLicense, type RepoList, type RepoListForCallerOptions, type RepoListOptions, type RepoListPageOptions, type RepoListPageResult, type RepoLocator, type RepoRecentInfo, type RepoRef, type RepoShapeInstanceCountsView, type RepoSort, type RepoStatsBatchResult, type RepoStatsView, type RepoWithStatsInfo, type RepositoryCheckpointAccess, type RepositoryCheckpointStatus, RepositoryExportError, type RepositoryExportErrorReason, type RepositoryExportExpectation, type RepositoryExportOptions, type RepositoryExportPreparation, type RepositoryExportPrepareOptions, type RepositoryExportRestoreOptions, type RepositoryExportRowMap, type RepositoryExportRows, type RepositoryExportSegmentOptions, RepositoryExportSession, type RequestEvent, type ResolveWrefResult, type RetractOp, type RetractOperation, type RetryPolicyOptions, type ReviseOp, type ReviseOperation, SDK_VERSION, type SearchOptions, type SearchResult, type Shape, type ShapeChange, type ShapeCreateOptions, type ShapeFields, type ShapeGetOptions, type ShapeHistory, type ShapeHistoryOptions, type ShapeList, type ShapeListOptions, type ShapeRef, type ShapeRemove, type ShapeRemoveOptions, type ShapeReviseOptions, type ShapeValidatorResult, type StreamAppendInput, type StreamAppendResult, type StreamContinuationState, StreamSubmissionAggregator, type StreamingSubmissionHandle, type StreamingSubmissionOptions, StreamingSubmissionOutcomeUnknownError, type StreamingSubmissionRetryIdentity, type StreamingSubmissionRow, type SubscriptionBindCredentialsResult, type SubscriptionCompatCreateInput, type SubscriptionCompatUpdateInput, type SubscriptionInfo, type SubscriptionList, type SubscriptionUnbindCredentialsResult, type SynthesizedRepoContent, type ThingChanges, type ThingDetail, type ThingGet, type ThingGetManyResult, type ThingGetOptions, type ThingGetWithLease, type ThingGraphOptions, type ThingGraphResult, type ThingGraphValue, type ThingHead, type ThingHeadChangesOptions, type ThingHeadOptions, type ThingHeadRequest, type ThingHeadVersionsResult, type ThingHistory, type ThingHistoryOptions, type ThingItem, type ThingMetadata, type ThingQueryChangesOptions, type TokenInfo, type TokenResult, type UndeclaredFieldsWarning, type ValidationDiagnostic, type ValidationResult, type VerifiedCliCall, type ViewEvaluateOptions, type ViewEvaluateResult, WarmHubClient, type WarmHubClientOptions, type WarmHubDecorations, WarmHubError, type WarmHubErrorDetails, type WherePredicate, type WhoamiInfo, type WhoamiScopeEntry, type WireScopeEntry, applyRepositoryExportDelta, collectDurableTokens, commitValidateRequestBodyBytes, connectionErrorMessage, contentFieldLimitError, countStreamAppendResultStatuses, createCommitValidateInput, createOperationEventRequestId, createOperationEventSubmissionId, createRepositoryExportSession, encodeCommitValidateRequestBody, getResponseDecorations, isConnectionError, isDefiniteStreamAppendRejection, isKnownOrgAuthScope, isKnownRepoAuthScope, isRetryable, isWarmHubError, normalizeWref, operationEventStreamRequestId, readRepositoryExportStream, resolveFunctionLogMode, restoreRepositoryExportSession, sanitizeErrorMessage, sdkVersionIsBelowMinimum, streamAppendResultStatus, submitOperationsViaStream, toWarmHubError, validateAgainstShape, verifyCliCall };