datocms-plugin-sdk 2.0.1 → 2.0.2

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.
Files changed (16) hide show
  1. package/dist/cjs/manifest.js +148 -76
  2. package/dist/cjs/manifest.js.map +1 -1
  3. package/dist/esm/ctx/commonExtras/field.d.ts +4 -0
  4. package/dist/esm/ctx/commonExtras/itemForm.d.ts +14 -12
  5. package/dist/esm/ctx/commonExtras/sizing.d.ts +1 -0
  6. package/dist/esm/manifest.js +148 -76
  7. package/dist/esm/manifest.js.map +1 -1
  8. package/dist/types/ctx/commonExtras/field.d.ts +4 -0
  9. package/dist/types/ctx/commonExtras/itemForm.d.ts +14 -12
  10. package/dist/types/ctx/commonExtras/sizing.d.ts +1 -0
  11. package/manifest.json +148 -76
  12. package/package.json +2 -2
  13. package/src/ctx/commonExtras/field.ts +4 -0
  14. package/src/ctx/commonExtras/itemForm.ts +15 -12
  15. package/src/ctx/commonExtras/sizing.ts +1 -0
  16. package/src/manifest.ts +174 -76
package/dist/esm/manifest.js CHANGED
@@ -418,6 +418,10 @@ export var manifest = {
418
418
  type: 'SelfResizingPluginFrameCtx',
419
419
  additionalProperties: [
420
420
  {
421
+ name: 'ItemFormAdditionalProperties',
422
+ comment: {
423
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
424
+ },
421
425
  items: {
422
426
  locale: {
423
427
  comment: {
@@ -491,13 +495,13 @@ export var manifest = {
491
495
  },
492
496
  blocksAnalysis: {
493
497
  comment: {
494
- comment: 'Current number of blocks present in form state',
498
+ comment: 'Provides information on how many blocks are currently present in the form',
495
499
  },
496
500
  location: {
497
501
  filePath: 'src/ctx/commonExtras/itemForm.ts',
498
502
  lineNumber: 29,
499
503
  },
500
- type: '{\n usage: {\n /** Total number of blocks present in form state */\n total: number;\n /** Total number of blocks present in non-localized fields */\n nonLocalized: number;\n /** Total number of blocks present in localized fields, per locale */\n perLocale: Record<string, number>;\n };\n /** Maximum number of blocks per item */\n maximumPerItem: number;\n }',
504
+ type: 'BlocksAnalysis',
501
505
  },
502
506
  },
503
507
  },
@@ -528,6 +532,10 @@ export var manifest = {
528
532
  ],
529
533
  additionalMethods: [
530
534
  {
535
+ name: 'ItemFormAdditionalMethods',
536
+ comment: {
537
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
538
+ },
531
539
  items: {
532
540
  toggleField: {
533
541
  comment: {
@@ -536,7 +544,7 @@ export var manifest = {
536
544
  },
537
545
  location: {
538
546
  filePath: 'src/ctx/commonExtras/itemForm.ts',
539
- lineNumber: 65,
547
+ lineNumber: 68,
540
548
  },
541
549
  type: '(path: string, show: boolean) => Promise<void>',
542
550
  },
@@ -547,7 +555,7 @@ export var manifest = {
547
555
  },
548
556
  location: {
549
557
  filePath: 'src/ctx/commonExtras/itemForm.ts',
550
- lineNumber: 80,
558
+ lineNumber: 83,
551
559
  },
552
560
  type: '(path: string, disable: boolean) => Promise<void>',
553
561
  },
@@ -558,7 +566,7 @@ export var manifest = {
558
566
  },
559
567
  location: {
560
568
  filePath: 'src/ctx/commonExtras/itemForm.ts',
561
- lineNumber: 97,
569
+ lineNumber: 100,
562
570
  },
563
571
  type: '(path: string, locale?: string) => Promise<void>',
564
572
  },
@@ -569,7 +577,7 @@ export var manifest = {
569
577
  },
570
578
  location: {
571
579
  filePath: 'src/ctx/commonExtras/itemForm.ts',
572
- lineNumber: 112,
580
+ lineNumber: 115,
573
581
  },
574
582
  type: '(path: string, value: unknown) => Promise<void>',
575
583
  },
@@ -580,7 +588,7 @@ export var manifest = {
580
588
  },
581
589
  location: {
582
590
  filePath: 'src/ctx/commonExtras/itemForm.ts',
583
- lineNumber: 129,
591
+ lineNumber: 132,
584
592
  },
585
593
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
586
594
  },
@@ -591,7 +599,7 @@ export var manifest = {
591
599
  },
592
600
  location: {
593
601
  filePath: 'src/ctx/commonExtras/itemForm.ts',
594
- lineNumber: 142,
602
+ lineNumber: 145,
595
603
  },
596
604
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
597
605
  },
@@ -602,7 +610,7 @@ export var manifest = {
602
610
  },
603
611
  location: {
604
612
  filePath: 'src/ctx/commonExtras/itemForm.ts',
605
- lineNumber: 154,
613
+ lineNumber: 157,
606
614
  },
607
615
  type: '(showToast?: boolean) => Promise<void>',
608
616
  },
@@ -632,6 +640,10 @@ export var manifest = {
632
640
  type: 'ImposedSizePluginFrameCtx',
633
641
  additionalProperties: [
634
642
  {
643
+ name: 'ItemFormAdditionalProperties',
644
+ comment: {
645
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
646
+ },
635
647
  items: {
636
648
  locale: {
637
649
  comment: {
@@ -705,13 +717,13 @@ export var manifest = {
705
717
  },
706
718
  blocksAnalysis: {
707
719
  comment: {
708
- comment: 'Current number of blocks present in form state',
720
+ comment: 'Provides information on how many blocks are currently present in the form',
709
721
  },
710
722
  location: {
711
723
  filePath: 'src/ctx/commonExtras/itemForm.ts',
712
724
  lineNumber: 29,
713
725
  },
714
- type: '{\n usage: {\n /** Total number of blocks present in form state */\n total: number;\n /** Total number of blocks present in non-localized fields */\n nonLocalized: number;\n /** Total number of blocks present in localized fields, per locale */\n perLocale: Record<string, number>;\n };\n /** Maximum number of blocks per item */\n maximumPerItem: number;\n }',
726
+ type: 'BlocksAnalysis',
715
727
  },
716
728
  },
717
729
  },
@@ -742,6 +754,10 @@ export var manifest = {
742
754
  ],
743
755
  additionalMethods: [
744
756
  {
757
+ name: 'ItemFormAdditionalMethods',
758
+ comment: {
759
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
760
+ },
745
761
  items: {
746
762
  toggleField: {
747
763
  comment: {
@@ -750,7 +766,7 @@ export var manifest = {
750
766
  },
751
767
  location: {
752
768
  filePath: 'src/ctx/commonExtras/itemForm.ts',
753
- lineNumber: 65,
769
+ lineNumber: 68,
754
770
  },
755
771
  type: '(path: string, show: boolean) => Promise<void>',
756
772
  },
@@ -761,7 +777,7 @@ export var manifest = {
761
777
  },
762
778
  location: {
763
779
  filePath: 'src/ctx/commonExtras/itemForm.ts',
764
- lineNumber: 80,
780
+ lineNumber: 83,
765
781
  },
766
782
  type: '(path: string, disable: boolean) => Promise<void>',
767
783
  },
@@ -772,7 +788,7 @@ export var manifest = {
772
788
  },
773
789
  location: {
774
790
  filePath: 'src/ctx/commonExtras/itemForm.ts',
775
- lineNumber: 97,
791
+ lineNumber: 100,
776
792
  },
777
793
  type: '(path: string, locale?: string) => Promise<void>',
778
794
  },
@@ -783,7 +799,7 @@ export var manifest = {
783
799
  },
784
800
  location: {
785
801
  filePath: 'src/ctx/commonExtras/itemForm.ts',
786
- lineNumber: 112,
802
+ lineNumber: 115,
787
803
  },
788
804
  type: '(path: string, value: unknown) => Promise<void>',
789
805
  },
@@ -794,7 +810,7 @@ export var manifest = {
794
810
  },
795
811
  location: {
796
812
  filePath: 'src/ctx/commonExtras/itemForm.ts',
797
- lineNumber: 129,
813
+ lineNumber: 132,
798
814
  },
799
815
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
800
816
  },
@@ -805,7 +821,7 @@ export var manifest = {
805
821
  },
806
822
  location: {
807
823
  filePath: 'src/ctx/commonExtras/itemForm.ts',
808
- lineNumber: 142,
824
+ lineNumber: 145,
809
825
  },
810
826
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
811
827
  },
@@ -816,7 +832,7 @@ export var manifest = {
816
832
  },
817
833
  location: {
818
834
  filePath: 'src/ctx/commonExtras/itemForm.ts',
819
- lineNumber: 154,
835
+ lineNumber: 157,
820
836
  },
821
837
  type: '(showToast?: boolean) => Promise<void>',
822
838
  },
@@ -846,6 +862,10 @@ export var manifest = {
846
862
  type: 'SelfResizingPluginFrameCtx',
847
863
  additionalProperties: [
848
864
  {
865
+ name: 'ItemFormAdditionalProperties',
866
+ comment: {
867
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
868
+ },
849
869
  items: {
850
870
  locale: {
851
871
  comment: {
@@ -919,13 +939,13 @@ export var manifest = {
919
939
  },
920
940
  blocksAnalysis: {
921
941
  comment: {
922
- comment: 'Current number of blocks present in form state',
942
+ comment: 'Provides information on how many blocks are currently present in the form',
923
943
  },
924
944
  location: {
925
945
  filePath: 'src/ctx/commonExtras/itemForm.ts',
926
946
  lineNumber: 29,
927
947
  },
928
- type: '{\n usage: {\n /** Total number of blocks present in form state */\n total: number;\n /** Total number of blocks present in non-localized fields */\n nonLocalized: number;\n /** Total number of blocks present in localized fields, per locale */\n perLocale: Record<string, number>;\n };\n /** Maximum number of blocks per item */\n maximumPerItem: number;\n }',
948
+ type: 'BlocksAnalysis',
929
949
  },
930
950
  },
931
951
  },
@@ -946,6 +966,10 @@ export var manifest = {
946
966
  ],
947
967
  additionalMethods: [
948
968
  {
969
+ name: 'ItemFormAdditionalMethods',
970
+ comment: {
971
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
972
+ },
949
973
  items: {
950
974
  toggleField: {
951
975
  comment: {
@@ -954,7 +978,7 @@ export var manifest = {
954
978
  },
955
979
  location: {
956
980
  filePath: 'src/ctx/commonExtras/itemForm.ts',
957
- lineNumber: 65,
981
+ lineNumber: 68,
958
982
  },
959
983
  type: '(path: string, show: boolean) => Promise<void>',
960
984
  },
@@ -965,7 +989,7 @@ export var manifest = {
965
989
  },
966
990
  location: {
967
991
  filePath: 'src/ctx/commonExtras/itemForm.ts',
968
- lineNumber: 80,
992
+ lineNumber: 83,
969
993
  },
970
994
  type: '(path: string, disable: boolean) => Promise<void>',
971
995
  },
@@ -976,7 +1000,7 @@ export var manifest = {
976
1000
  },
977
1001
  location: {
978
1002
  filePath: 'src/ctx/commonExtras/itemForm.ts',
979
- lineNumber: 97,
1003
+ lineNumber: 100,
980
1004
  },
981
1005
  type: '(path: string, locale?: string) => Promise<void>',
982
1006
  },
@@ -987,7 +1011,7 @@ export var manifest = {
987
1011
  },
988
1012
  location: {
989
1013
  filePath: 'src/ctx/commonExtras/itemForm.ts',
990
- lineNumber: 112,
1014
+ lineNumber: 115,
991
1015
  },
992
1016
  type: '(path: string, value: unknown) => Promise<void>',
993
1017
  },
@@ -998,7 +1022,7 @@ export var manifest = {
998
1022
  },
999
1023
  location: {
1000
1024
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1001
- lineNumber: 129,
1025
+ lineNumber: 132,
1002
1026
  },
1003
1027
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
1004
1028
  },
@@ -1009,7 +1033,7 @@ export var manifest = {
1009
1033
  },
1010
1034
  location: {
1011
1035
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1012
- lineNumber: 142,
1036
+ lineNumber: 145,
1013
1037
  },
1014
1038
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
1015
1039
  },
@@ -1020,7 +1044,7 @@ export var manifest = {
1020
1044
  },
1021
1045
  location: {
1022
1046
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1023
- lineNumber: 154,
1047
+ lineNumber: 157,
1024
1048
  },
1025
1049
  type: '(showToast?: boolean) => Promise<void>',
1026
1050
  },
@@ -1088,6 +1112,10 @@ export var manifest = {
1088
1112
  type: 'SelfResizingPluginFrameCtx',
1089
1113
  additionalProperties: [
1090
1114
  {
1115
+ name: 'ItemFormAdditionalProperties',
1116
+ comment: {
1117
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1118
+ },
1091
1119
  items: {
1092
1120
  locale: {
1093
1121
  comment: {
@@ -1161,17 +1189,21 @@ export var manifest = {
1161
1189
  },
1162
1190
  blocksAnalysis: {
1163
1191
  comment: {
1164
- comment: 'Current number of blocks present in form state',
1192
+ comment: 'Provides information on how many blocks are currently present in the form',
1165
1193
  },
1166
1194
  location: {
1167
1195
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1168
1196
  lineNumber: 29,
1169
1197
  },
1170
- type: '{\n usage: {\n /** Total number of blocks present in form state */\n total: number;\n /** Total number of blocks present in non-localized fields */\n nonLocalized: number;\n /** Total number of blocks present in localized fields, per locale */\n perLocale: Record<string, number>;\n };\n /** Maximum number of blocks per item */\n maximumPerItem: number;\n }',
1198
+ type: 'BlocksAnalysis',
1171
1199
  },
1172
1200
  },
1173
1201
  },
1174
1202
  {
1203
+ name: 'FieldAdditionalProperties',
1204
+ comment: {
1205
+ comment: 'These information describe the current state of the field where this plugin\nis applied to.',
1206
+ },
1175
1207
  items: {
1176
1208
  disabled: {
1177
1209
  comment: {
@@ -1179,7 +1211,7 @@ export var manifest = {
1179
1211
  },
1180
1212
  location: {
1181
1213
  filePath: 'src/ctx/commonExtras/field.ts',
1182
- lineNumber: 8,
1214
+ lineNumber: 12,
1183
1215
  },
1184
1216
  type: 'boolean',
1185
1217
  },
@@ -1189,7 +1221,7 @@ export var manifest = {
1189
1221
  },
1190
1222
  location: {
1191
1223
  filePath: 'src/ctx/commonExtras/field.ts',
1192
- lineNumber: 13,
1224
+ lineNumber: 17,
1193
1225
  },
1194
1226
  type: 'string',
1195
1227
  },
@@ -1199,7 +1231,7 @@ export var manifest = {
1199
1231
  },
1200
1232
  location: {
1201
1233
  filePath: 'src/ctx/commonExtras/field.ts',
1202
- lineNumber: 15,
1234
+ lineNumber: 19,
1203
1235
  },
1204
1236
  type: 'Field',
1205
1237
  },
@@ -1209,7 +1241,7 @@ export var manifest = {
1209
1241
  },
1210
1242
  location: {
1211
1243
  filePath: 'src/ctx/commonExtras/field.ts',
1212
- lineNumber: 20,
1244
+ lineNumber: 24,
1213
1245
  },
1214
1246
  type: 'Field | undefined',
1215
1247
  },
@@ -1219,7 +1251,7 @@ export var manifest = {
1219
1251
  },
1220
1252
  location: {
1221
1253
  filePath: 'src/ctx/commonExtras/field.ts',
1222
- lineNumber: 26,
1254
+ lineNumber: 30,
1223
1255
  },
1224
1256
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
1225
1257
  },
@@ -1252,6 +1284,10 @@ export var manifest = {
1252
1284
  ],
1253
1285
  additionalMethods: [
1254
1286
  {
1287
+ name: 'ItemFormAdditionalMethods',
1288
+ comment: {
1289
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
1290
+ },
1255
1291
  items: {
1256
1292
  toggleField: {
1257
1293
  comment: {
@@ -1260,7 +1296,7 @@ export var manifest = {
1260
1296
  },
1261
1297
  location: {
1262
1298
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1263
- lineNumber: 65,
1299
+ lineNumber: 68,
1264
1300
  },
1265
1301
  type: '(path: string, show: boolean) => Promise<void>',
1266
1302
  },
@@ -1271,7 +1307,7 @@ export var manifest = {
1271
1307
  },
1272
1308
  location: {
1273
1309
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1274
- lineNumber: 80,
1310
+ lineNumber: 83,
1275
1311
  },
1276
1312
  type: '(path: string, disable: boolean) => Promise<void>',
1277
1313
  },
@@ -1282,7 +1318,7 @@ export var manifest = {
1282
1318
  },
1283
1319
  location: {
1284
1320
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1285
- lineNumber: 97,
1321
+ lineNumber: 100,
1286
1322
  },
1287
1323
  type: '(path: string, locale?: string) => Promise<void>',
1288
1324
  },
@@ -1293,7 +1329,7 @@ export var manifest = {
1293
1329
  },
1294
1330
  location: {
1295
1331
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1296
- lineNumber: 112,
1332
+ lineNumber: 115,
1297
1333
  },
1298
1334
  type: '(path: string, value: unknown) => Promise<void>',
1299
1335
  },
@@ -1304,7 +1340,7 @@ export var manifest = {
1304
1340
  },
1305
1341
  location: {
1306
1342
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1307
- lineNumber: 129,
1343
+ lineNumber: 132,
1308
1344
  },
1309
1345
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
1310
1346
  },
@@ -1315,7 +1351,7 @@ export var manifest = {
1315
1351
  },
1316
1352
  location: {
1317
1353
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1318
- lineNumber: 142,
1354
+ lineNumber: 145,
1319
1355
  },
1320
1356
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
1321
1357
  },
@@ -1326,7 +1362,7 @@ export var manifest = {
1326
1362
  },
1327
1363
  location: {
1328
1364
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1329
- lineNumber: 154,
1365
+ lineNumber: 157,
1330
1366
  },
1331
1367
  type: '(showToast?: boolean) => Promise<void>',
1332
1368
  },
@@ -1713,6 +1749,10 @@ export var manifest = {
1713
1749
  type: 'Ctx',
1714
1750
  additionalProperties: [
1715
1751
  {
1752
+ name: 'ItemFormAdditionalProperties',
1753
+ comment: {
1754
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1755
+ },
1716
1756
  items: {
1717
1757
  locale: {
1718
1758
  comment: {
@@ -1786,13 +1826,13 @@ export var manifest = {
1786
1826
  },
1787
1827
  blocksAnalysis: {
1788
1828
  comment: {
1789
- comment: 'Current number of blocks present in form state',
1829
+ comment: 'Provides information on how many blocks are currently present in the form',
1790
1830
  },
1791
1831
  location: {
1792
1832
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1793
1833
  lineNumber: 29,
1794
1834
  },
1795
- type: '{\n usage: {\n /** Total number of blocks present in form state */\n total: number;\n /** Total number of blocks present in non-localized fields */\n nonLocalized: number;\n /** Total number of blocks present in localized fields, per locale */\n perLocale: Record<string, number>;\n };\n /** Maximum number of blocks per item */\n maximumPerItem: number;\n }',
1835
+ type: 'BlocksAnalysis',
1796
1836
  },
1797
1837
  },
1798
1838
  },
@@ -1871,6 +1911,10 @@ export var manifest = {
1871
1911
  type: 'Ctx',
1872
1912
  additionalProperties: [
1873
1913
  {
1914
+ name: 'ItemFormAdditionalProperties',
1915
+ comment: {
1916
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1917
+ },
1874
1918
  items: {
1875
1919
  locale: {
1876
1920
  comment: {
@@ -1944,17 +1988,21 @@ export var manifest = {
1944
1988
  },
1945
1989
  blocksAnalysis: {
1946
1990
  comment: {
1947
- comment: 'Current number of blocks present in form state',
1991
+ comment: 'Provides information on how many blocks are currently present in the form',
1948
1992
  },
1949
1993
  location: {
1950
1994
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1951
1995
  lineNumber: 29,
1952
1996
  },
1953
- type: '{\n usage: {\n /** Total number of blocks present in form state */\n total: number;\n /** Total number of blocks present in non-localized fields */\n nonLocalized: number;\n /** Total number of blocks present in localized fields, per locale */\n perLocale: Record<string, number>;\n };\n /** Maximum number of blocks per item */\n maximumPerItem: number;\n }',
1997
+ type: 'BlocksAnalysis',
1954
1998
  },
1955
1999
  },
1956
2000
  },
1957
2001
  {
2002
+ name: 'FieldAdditionalProperties',
2003
+ comment: {
2004
+ comment: 'These information describe the current state of the field where this plugin\nis applied to.',
2005
+ },
1958
2006
  items: {
1959
2007
  disabled: {
1960
2008
  comment: {
@@ -1962,7 +2010,7 @@ export var manifest = {
1962
2010
  },
1963
2011
  location: {
1964
2012
  filePath: 'src/ctx/commonExtras/field.ts',
1965
- lineNumber: 8,
2013
+ lineNumber: 12,
1966
2014
  },
1967
2015
  type: 'boolean',
1968
2016
  },
@@ -1972,7 +2020,7 @@ export var manifest = {
1972
2020
  },
1973
2021
  location: {
1974
2022
  filePath: 'src/ctx/commonExtras/field.ts',
1975
- lineNumber: 13,
2023
+ lineNumber: 17,
1976
2024
  },
1977
2025
  type: 'string',
1978
2026
  },
@@ -1982,7 +2030,7 @@ export var manifest = {
1982
2030
  },
1983
2031
  location: {
1984
2032
  filePath: 'src/ctx/commonExtras/field.ts',
1985
- lineNumber: 15,
2033
+ lineNumber: 19,
1986
2034
  },
1987
2035
  type: 'Field',
1988
2036
  },
@@ -1992,7 +2040,7 @@ export var manifest = {
1992
2040
  },
1993
2041
  location: {
1994
2042
  filePath: 'src/ctx/commonExtras/field.ts',
1995
- lineNumber: 20,
2043
+ lineNumber: 24,
1996
2044
  },
1997
2045
  type: 'Field | undefined',
1998
2046
  },
@@ -2002,7 +2050,7 @@ export var manifest = {
2002
2050
  },
2003
2051
  location: {
2004
2052
  filePath: 'src/ctx/commonExtras/field.ts',
2005
- lineNumber: 26,
2053
+ lineNumber: 30,
2006
2054
  },
2007
2055
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
2008
2056
  },
@@ -2111,6 +2159,10 @@ export var manifest = {
2111
2159
  type: 'Ctx',
2112
2160
  additionalProperties: [
2113
2161
  {
2162
+ name: 'ItemFormAdditionalProperties',
2163
+ comment: {
2164
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2165
+ },
2114
2166
  items: {
2115
2167
  locale: {
2116
2168
  comment: {
@@ -2184,13 +2236,13 @@ export var manifest = {
2184
2236
  },
2185
2237
  blocksAnalysis: {
2186
2238
  comment: {
2187
- comment: 'Current number of blocks present in form state',
2239
+ comment: 'Provides information on how many blocks are currently present in the form',
2188
2240
  },
2189
2241
  location: {
2190
2242
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2191
2243
  lineNumber: 29,
2192
2244
  },
2193
- type: '{\n usage: {\n /** Total number of blocks present in form state */\n total: number;\n /** Total number of blocks present in non-localized fields */\n nonLocalized: number;\n /** Total number of blocks present in localized fields, per locale */\n perLocale: Record<string, number>;\n };\n /** Maximum number of blocks per item */\n maximumPerItem: number;\n }',
2245
+ type: 'BlocksAnalysis',
2194
2246
  },
2195
2247
  },
2196
2248
  },
@@ -2208,6 +2260,10 @@ export var manifest = {
2208
2260
  ],
2209
2261
  additionalMethods: [
2210
2262
  {
2263
+ name: 'ItemFormAdditionalMethods',
2264
+ comment: {
2265
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2266
+ },
2211
2267
  items: {
2212
2268
  toggleField: {
2213
2269
  comment: {
@@ -2216,7 +2272,7 @@ export var manifest = {
2216
2272
  },
2217
2273
  location: {
2218
2274
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2219
- lineNumber: 65,
2275
+ lineNumber: 68,
2220
2276
  },
2221
2277
  type: '(path: string, show: boolean) => Promise<void>',
2222
2278
  },
@@ -2227,7 +2283,7 @@ export var manifest = {
2227
2283
  },
2228
2284
  location: {
2229
2285
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2230
- lineNumber: 80,
2286
+ lineNumber: 83,
2231
2287
  },
2232
2288
  type: '(path: string, disable: boolean) => Promise<void>',
2233
2289
  },
@@ -2238,7 +2294,7 @@ export var manifest = {
2238
2294
  },
2239
2295
  location: {
2240
2296
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2241
- lineNumber: 97,
2297
+ lineNumber: 100,
2242
2298
  },
2243
2299
  type: '(path: string, locale?: string) => Promise<void>',
2244
2300
  },
@@ -2249,7 +2305,7 @@ export var manifest = {
2249
2305
  },
2250
2306
  location: {
2251
2307
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2252
- lineNumber: 112,
2308
+ lineNumber: 115,
2253
2309
  },
2254
2310
  type: '(path: string, value: unknown) => Promise<void>',
2255
2311
  },
@@ -2260,7 +2316,7 @@ export var manifest = {
2260
2316
  },
2261
2317
  location: {
2262
2318
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2263
- lineNumber: 129,
2319
+ lineNumber: 132,
2264
2320
  },
2265
2321
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
2266
2322
  },
@@ -2271,7 +2327,7 @@ export var manifest = {
2271
2327
  },
2272
2328
  location: {
2273
2329
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2274
- lineNumber: 142,
2330
+ lineNumber: 145,
2275
2331
  },
2276
2332
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
2277
2333
  },
@@ -2282,7 +2338,7 @@ export var manifest = {
2282
2338
  },
2283
2339
  location: {
2284
2340
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2285
- lineNumber: 154,
2341
+ lineNumber: 157,
2286
2342
  },
2287
2343
  type: '(showToast?: boolean) => Promise<void>',
2288
2344
  },
@@ -2312,6 +2368,10 @@ export var manifest = {
2312
2368
  type: 'Ctx',
2313
2369
  additionalProperties: [
2314
2370
  {
2371
+ name: 'ItemFormAdditionalProperties',
2372
+ comment: {
2373
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2374
+ },
2315
2375
  items: {
2316
2376
  locale: {
2317
2377
  comment: {
@@ -2385,17 +2445,21 @@ export var manifest = {
2385
2445
  },
2386
2446
  blocksAnalysis: {
2387
2447
  comment: {
2388
- comment: 'Current number of blocks present in form state',
2448
+ comment: 'Provides information on how many blocks are currently present in the form',
2389
2449
  },
2390
2450
  location: {
2391
2451
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2392
2452
  lineNumber: 29,
2393
2453
  },
2394
- type: '{\n usage: {\n /** Total number of blocks present in form state */\n total: number;\n /** Total number of blocks present in non-localized fields */\n nonLocalized: number;\n /** Total number of blocks present in localized fields, per locale */\n perLocale: Record<string, number>;\n };\n /** Maximum number of blocks per item */\n maximumPerItem: number;\n }',
2454
+ type: 'BlocksAnalysis',
2395
2455
  },
2396
2456
  },
2397
2457
  },
2398
2458
  {
2459
+ name: 'FieldAdditionalProperties',
2460
+ comment: {
2461
+ comment: 'These information describe the current state of the field where this plugin\nis applied to.',
2462
+ },
2399
2463
  items: {
2400
2464
  disabled: {
2401
2465
  comment: {
@@ -2403,7 +2467,7 @@ export var manifest = {
2403
2467
  },
2404
2468
  location: {
2405
2469
  filePath: 'src/ctx/commonExtras/field.ts',
2406
- lineNumber: 8,
2470
+ lineNumber: 12,
2407
2471
  },
2408
2472
  type: 'boolean',
2409
2473
  },
@@ -2413,7 +2477,7 @@ export var manifest = {
2413
2477
  },
2414
2478
  location: {
2415
2479
  filePath: 'src/ctx/commonExtras/field.ts',
2416
- lineNumber: 13,
2480
+ lineNumber: 17,
2417
2481
  },
2418
2482
  type: 'string',
2419
2483
  },
@@ -2423,7 +2487,7 @@ export var manifest = {
2423
2487
  },
2424
2488
  location: {
2425
2489
  filePath: 'src/ctx/commonExtras/field.ts',
2426
- lineNumber: 15,
2490
+ lineNumber: 19,
2427
2491
  },
2428
2492
  type: 'Field',
2429
2493
  },
@@ -2433,7 +2497,7 @@ export var manifest = {
2433
2497
  },
2434
2498
  location: {
2435
2499
  filePath: 'src/ctx/commonExtras/field.ts',
2436
- lineNumber: 20,
2500
+ lineNumber: 24,
2437
2501
  },
2438
2502
  type: 'Field | undefined',
2439
2503
  },
@@ -2443,7 +2507,7 @@ export var manifest = {
2443
2507
  },
2444
2508
  location: {
2445
2509
  filePath: 'src/ctx/commonExtras/field.ts',
2446
- lineNumber: 26,
2510
+ lineNumber: 30,
2447
2511
  },
2448
2512
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
2449
2513
  },
@@ -2463,6 +2527,10 @@ export var manifest = {
2463
2527
  ],
2464
2528
  additionalMethods: [
2465
2529
  {
2530
+ name: 'ItemFormAdditionalMethods',
2531
+ comment: {
2532
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2533
+ },
2466
2534
  items: {
2467
2535
  toggleField: {
2468
2536
  comment: {
@@ -2471,7 +2539,7 @@ export var manifest = {
2471
2539
  },
2472
2540
  location: {
2473
2541
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2474
- lineNumber: 65,
2542
+ lineNumber: 68,
2475
2543
  },
2476
2544
  type: '(path: string, show: boolean) => Promise<void>',
2477
2545
  },
@@ -2482,7 +2550,7 @@ export var manifest = {
2482
2550
  },
2483
2551
  location: {
2484
2552
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2485
- lineNumber: 80,
2553
+ lineNumber: 83,
2486
2554
  },
2487
2555
  type: '(path: string, disable: boolean) => Promise<void>',
2488
2556
  },
@@ -2493,7 +2561,7 @@ export var manifest = {
2493
2561
  },
2494
2562
  location: {
2495
2563
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2496
- lineNumber: 97,
2564
+ lineNumber: 100,
2497
2565
  },
2498
2566
  type: '(path: string, locale?: string) => Promise<void>',
2499
2567
  },
@@ -2504,7 +2572,7 @@ export var manifest = {
2504
2572
  },
2505
2573
  location: {
2506
2574
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2507
- lineNumber: 112,
2575
+ lineNumber: 115,
2508
2576
  },
2509
2577
  type: '(path: string, value: unknown) => Promise<void>',
2510
2578
  },
@@ -2515,7 +2583,7 @@ export var manifest = {
2515
2583
  },
2516
2584
  location: {
2517
2585
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2518
- lineNumber: 129,
2586
+ lineNumber: 132,
2519
2587
  },
2520
2588
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
2521
2589
  },
@@ -2526,7 +2594,7 @@ export var manifest = {
2526
2594
  },
2527
2595
  location: {
2528
2596
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2529
- lineNumber: 142,
2597
+ lineNumber: 145,
2530
2598
  },
2531
2599
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
2532
2600
  },
@@ -2537,7 +2605,7 @@ export var manifest = {
2537
2605
  },
2538
2606
  location: {
2539
2607
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2540
- lineNumber: 154,
2608
+ lineNumber: 157,
2541
2609
  },
2542
2610
  type: '(showToast?: boolean) => Promise<void>',
2543
2611
  },
@@ -3132,6 +3200,10 @@ export var manifest = {
3132
3200
  ],
3133
3201
  },
3134
3202
  selfResizingPluginFrameCtxSizingUtilities: {
3203
+ name: 'SizingUtilities',
3204
+ comment: {
3205
+ comment: 'A number of methods that you can use to control the size of the plugin frame',
3206
+ },
3135
3207
  items: {
3136
3208
  startAutoResizer: {
3137
3209
  comment: {
@@ -3139,7 +3211,7 @@ export var manifest = {
3139
3211
  },
3140
3212
  location: {
3141
3213
  filePath: 'src/ctx/commonExtras/sizing.ts',
3142
- lineNumber: 7,
3214
+ lineNumber: 8,
3143
3215
  },
3144
3216
  type: '() => void',
3145
3217
  },
@@ -3149,7 +3221,7 @@ export var manifest = {
3149
3221
  },
3150
3222
  location: {
3151
3223
  filePath: 'src/ctx/commonExtras/sizing.ts',
3152
- lineNumber: 10,
3224
+ lineNumber: 11,
3153
3225
  },
3154
3226
  type: '() => void',
3155
3227
  },
@@ -3159,7 +3231,7 @@ export var manifest = {
3159
3231
  },
3160
3232
  location: {
3161
3233
  filePath: 'src/ctx/commonExtras/sizing.ts',
3162
- lineNumber: 17,
3234
+ lineNumber: 18,
3163
3235
  },
3164
3236
  type: '(newHeight?: number) => void',
3165
3237
  },