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/cjs/manifest.js CHANGED
@@ -421,6 +421,10 @@ exports.manifest = {
421
421
  type: 'SelfResizingPluginFrameCtx',
422
422
  additionalProperties: [
423
423
  {
424
+ name: 'ItemFormAdditionalProperties',
425
+ comment: {
426
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
427
+ },
424
428
  items: {
425
429
  locale: {
426
430
  comment: {
@@ -494,13 +498,13 @@ exports.manifest = {
494
498
  },
495
499
  blocksAnalysis: {
496
500
  comment: {
497
- comment: 'Current number of blocks present in form state',
501
+ comment: 'Provides information on how many blocks are currently present in the form',
498
502
  },
499
503
  location: {
500
504
  filePath: 'src/ctx/commonExtras/itemForm.ts',
501
505
  lineNumber: 29,
502
506
  },
503
- 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 }',
507
+ type: 'BlocksAnalysis',
504
508
  },
505
509
  },
506
510
  },
@@ -531,6 +535,10 @@ exports.manifest = {
531
535
  ],
532
536
  additionalMethods: [
533
537
  {
538
+ name: 'ItemFormAdditionalMethods',
539
+ comment: {
540
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
541
+ },
534
542
  items: {
535
543
  toggleField: {
536
544
  comment: {
@@ -539,7 +547,7 @@ exports.manifest = {
539
547
  },
540
548
  location: {
541
549
  filePath: 'src/ctx/commonExtras/itemForm.ts',
542
- lineNumber: 65,
550
+ lineNumber: 68,
543
551
  },
544
552
  type: '(path: string, show: boolean) => Promise<void>',
545
553
  },
@@ -550,7 +558,7 @@ exports.manifest = {
550
558
  },
551
559
  location: {
552
560
  filePath: 'src/ctx/commonExtras/itemForm.ts',
553
- lineNumber: 80,
561
+ lineNumber: 83,
554
562
  },
555
563
  type: '(path: string, disable: boolean) => Promise<void>',
556
564
  },
@@ -561,7 +569,7 @@ exports.manifest = {
561
569
  },
562
570
  location: {
563
571
  filePath: 'src/ctx/commonExtras/itemForm.ts',
564
- lineNumber: 97,
572
+ lineNumber: 100,
565
573
  },
566
574
  type: '(path: string, locale?: string) => Promise<void>',
567
575
  },
@@ -572,7 +580,7 @@ exports.manifest = {
572
580
  },
573
581
  location: {
574
582
  filePath: 'src/ctx/commonExtras/itemForm.ts',
575
- lineNumber: 112,
583
+ lineNumber: 115,
576
584
  },
577
585
  type: '(path: string, value: unknown) => Promise<void>',
578
586
  },
@@ -583,7 +591,7 @@ exports.manifest = {
583
591
  },
584
592
  location: {
585
593
  filePath: 'src/ctx/commonExtras/itemForm.ts',
586
- lineNumber: 129,
594
+ lineNumber: 132,
587
595
  },
588
596
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
589
597
  },
@@ -594,7 +602,7 @@ exports.manifest = {
594
602
  },
595
603
  location: {
596
604
  filePath: 'src/ctx/commonExtras/itemForm.ts',
597
- lineNumber: 142,
605
+ lineNumber: 145,
598
606
  },
599
607
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
600
608
  },
@@ -605,7 +613,7 @@ exports.manifest = {
605
613
  },
606
614
  location: {
607
615
  filePath: 'src/ctx/commonExtras/itemForm.ts',
608
- lineNumber: 154,
616
+ lineNumber: 157,
609
617
  },
610
618
  type: '(showToast?: boolean) => Promise<void>',
611
619
  },
@@ -635,6 +643,10 @@ exports.manifest = {
635
643
  type: 'ImposedSizePluginFrameCtx',
636
644
  additionalProperties: [
637
645
  {
646
+ name: 'ItemFormAdditionalProperties',
647
+ comment: {
648
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
649
+ },
638
650
  items: {
639
651
  locale: {
640
652
  comment: {
@@ -708,13 +720,13 @@ exports.manifest = {
708
720
  },
709
721
  blocksAnalysis: {
710
722
  comment: {
711
- comment: 'Current number of blocks present in form state',
723
+ comment: 'Provides information on how many blocks are currently present in the form',
712
724
  },
713
725
  location: {
714
726
  filePath: 'src/ctx/commonExtras/itemForm.ts',
715
727
  lineNumber: 29,
716
728
  },
717
- 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 }',
729
+ type: 'BlocksAnalysis',
718
730
  },
719
731
  },
720
732
  },
@@ -745,6 +757,10 @@ exports.manifest = {
745
757
  ],
746
758
  additionalMethods: [
747
759
  {
760
+ name: 'ItemFormAdditionalMethods',
761
+ comment: {
762
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
763
+ },
748
764
  items: {
749
765
  toggleField: {
750
766
  comment: {
@@ -753,7 +769,7 @@ exports.manifest = {
753
769
  },
754
770
  location: {
755
771
  filePath: 'src/ctx/commonExtras/itemForm.ts',
756
- lineNumber: 65,
772
+ lineNumber: 68,
757
773
  },
758
774
  type: '(path: string, show: boolean) => Promise<void>',
759
775
  },
@@ -764,7 +780,7 @@ exports.manifest = {
764
780
  },
765
781
  location: {
766
782
  filePath: 'src/ctx/commonExtras/itemForm.ts',
767
- lineNumber: 80,
783
+ lineNumber: 83,
768
784
  },
769
785
  type: '(path: string, disable: boolean) => Promise<void>',
770
786
  },
@@ -775,7 +791,7 @@ exports.manifest = {
775
791
  },
776
792
  location: {
777
793
  filePath: 'src/ctx/commonExtras/itemForm.ts',
778
- lineNumber: 97,
794
+ lineNumber: 100,
779
795
  },
780
796
  type: '(path: string, locale?: string) => Promise<void>',
781
797
  },
@@ -786,7 +802,7 @@ exports.manifest = {
786
802
  },
787
803
  location: {
788
804
  filePath: 'src/ctx/commonExtras/itemForm.ts',
789
- lineNumber: 112,
805
+ lineNumber: 115,
790
806
  },
791
807
  type: '(path: string, value: unknown) => Promise<void>',
792
808
  },
@@ -797,7 +813,7 @@ exports.manifest = {
797
813
  },
798
814
  location: {
799
815
  filePath: 'src/ctx/commonExtras/itemForm.ts',
800
- lineNumber: 129,
816
+ lineNumber: 132,
801
817
  },
802
818
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
803
819
  },
@@ -808,7 +824,7 @@ exports.manifest = {
808
824
  },
809
825
  location: {
810
826
  filePath: 'src/ctx/commonExtras/itemForm.ts',
811
- lineNumber: 142,
827
+ lineNumber: 145,
812
828
  },
813
829
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
814
830
  },
@@ -819,7 +835,7 @@ exports.manifest = {
819
835
  },
820
836
  location: {
821
837
  filePath: 'src/ctx/commonExtras/itemForm.ts',
822
- lineNumber: 154,
838
+ lineNumber: 157,
823
839
  },
824
840
  type: '(showToast?: boolean) => Promise<void>',
825
841
  },
@@ -849,6 +865,10 @@ exports.manifest = {
849
865
  type: 'SelfResizingPluginFrameCtx',
850
866
  additionalProperties: [
851
867
  {
868
+ name: 'ItemFormAdditionalProperties',
869
+ comment: {
870
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
871
+ },
852
872
  items: {
853
873
  locale: {
854
874
  comment: {
@@ -922,13 +942,13 @@ exports.manifest = {
922
942
  },
923
943
  blocksAnalysis: {
924
944
  comment: {
925
- comment: 'Current number of blocks present in form state',
945
+ comment: 'Provides information on how many blocks are currently present in the form',
926
946
  },
927
947
  location: {
928
948
  filePath: 'src/ctx/commonExtras/itemForm.ts',
929
949
  lineNumber: 29,
930
950
  },
931
- 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 }',
951
+ type: 'BlocksAnalysis',
932
952
  },
933
953
  },
934
954
  },
@@ -949,6 +969,10 @@ exports.manifest = {
949
969
  ],
950
970
  additionalMethods: [
951
971
  {
972
+ name: 'ItemFormAdditionalMethods',
973
+ comment: {
974
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
975
+ },
952
976
  items: {
953
977
  toggleField: {
954
978
  comment: {
@@ -957,7 +981,7 @@ exports.manifest = {
957
981
  },
958
982
  location: {
959
983
  filePath: 'src/ctx/commonExtras/itemForm.ts',
960
- lineNumber: 65,
984
+ lineNumber: 68,
961
985
  },
962
986
  type: '(path: string, show: boolean) => Promise<void>',
963
987
  },
@@ -968,7 +992,7 @@ exports.manifest = {
968
992
  },
969
993
  location: {
970
994
  filePath: 'src/ctx/commonExtras/itemForm.ts',
971
- lineNumber: 80,
995
+ lineNumber: 83,
972
996
  },
973
997
  type: '(path: string, disable: boolean) => Promise<void>',
974
998
  },
@@ -979,7 +1003,7 @@ exports.manifest = {
979
1003
  },
980
1004
  location: {
981
1005
  filePath: 'src/ctx/commonExtras/itemForm.ts',
982
- lineNumber: 97,
1006
+ lineNumber: 100,
983
1007
  },
984
1008
  type: '(path: string, locale?: string) => Promise<void>',
985
1009
  },
@@ -990,7 +1014,7 @@ exports.manifest = {
990
1014
  },
991
1015
  location: {
992
1016
  filePath: 'src/ctx/commonExtras/itemForm.ts',
993
- lineNumber: 112,
1017
+ lineNumber: 115,
994
1018
  },
995
1019
  type: '(path: string, value: unknown) => Promise<void>',
996
1020
  },
@@ -1001,7 +1025,7 @@ exports.manifest = {
1001
1025
  },
1002
1026
  location: {
1003
1027
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1004
- lineNumber: 129,
1028
+ lineNumber: 132,
1005
1029
  },
1006
1030
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
1007
1031
  },
@@ -1012,7 +1036,7 @@ exports.manifest = {
1012
1036
  },
1013
1037
  location: {
1014
1038
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1015
- lineNumber: 142,
1039
+ lineNumber: 145,
1016
1040
  },
1017
1041
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
1018
1042
  },
@@ -1023,7 +1047,7 @@ exports.manifest = {
1023
1047
  },
1024
1048
  location: {
1025
1049
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1026
- lineNumber: 154,
1050
+ lineNumber: 157,
1027
1051
  },
1028
1052
  type: '(showToast?: boolean) => Promise<void>',
1029
1053
  },
@@ -1091,6 +1115,10 @@ exports.manifest = {
1091
1115
  type: 'SelfResizingPluginFrameCtx',
1092
1116
  additionalProperties: [
1093
1117
  {
1118
+ name: 'ItemFormAdditionalProperties',
1119
+ comment: {
1120
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1121
+ },
1094
1122
  items: {
1095
1123
  locale: {
1096
1124
  comment: {
@@ -1164,17 +1192,21 @@ exports.manifest = {
1164
1192
  },
1165
1193
  blocksAnalysis: {
1166
1194
  comment: {
1167
- comment: 'Current number of blocks present in form state',
1195
+ comment: 'Provides information on how many blocks are currently present in the form',
1168
1196
  },
1169
1197
  location: {
1170
1198
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1171
1199
  lineNumber: 29,
1172
1200
  },
1173
- 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 }',
1201
+ type: 'BlocksAnalysis',
1174
1202
  },
1175
1203
  },
1176
1204
  },
1177
1205
  {
1206
+ name: 'FieldAdditionalProperties',
1207
+ comment: {
1208
+ comment: 'These information describe the current state of the field where this plugin\nis applied to.',
1209
+ },
1178
1210
  items: {
1179
1211
  disabled: {
1180
1212
  comment: {
@@ -1182,7 +1214,7 @@ exports.manifest = {
1182
1214
  },
1183
1215
  location: {
1184
1216
  filePath: 'src/ctx/commonExtras/field.ts',
1185
- lineNumber: 8,
1217
+ lineNumber: 12,
1186
1218
  },
1187
1219
  type: 'boolean',
1188
1220
  },
@@ -1192,7 +1224,7 @@ exports.manifest = {
1192
1224
  },
1193
1225
  location: {
1194
1226
  filePath: 'src/ctx/commonExtras/field.ts',
1195
- lineNumber: 13,
1227
+ lineNumber: 17,
1196
1228
  },
1197
1229
  type: 'string',
1198
1230
  },
@@ -1202,7 +1234,7 @@ exports.manifest = {
1202
1234
  },
1203
1235
  location: {
1204
1236
  filePath: 'src/ctx/commonExtras/field.ts',
1205
- lineNumber: 15,
1237
+ lineNumber: 19,
1206
1238
  },
1207
1239
  type: 'Field',
1208
1240
  },
@@ -1212,7 +1244,7 @@ exports.manifest = {
1212
1244
  },
1213
1245
  location: {
1214
1246
  filePath: 'src/ctx/commonExtras/field.ts',
1215
- lineNumber: 20,
1247
+ lineNumber: 24,
1216
1248
  },
1217
1249
  type: 'Field | undefined',
1218
1250
  },
@@ -1222,7 +1254,7 @@ exports.manifest = {
1222
1254
  },
1223
1255
  location: {
1224
1256
  filePath: 'src/ctx/commonExtras/field.ts',
1225
- lineNumber: 26,
1257
+ lineNumber: 30,
1226
1258
  },
1227
1259
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
1228
1260
  },
@@ -1255,6 +1287,10 @@ exports.manifest = {
1255
1287
  ],
1256
1288
  additionalMethods: [
1257
1289
  {
1290
+ name: 'ItemFormAdditionalMethods',
1291
+ comment: {
1292
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
1293
+ },
1258
1294
  items: {
1259
1295
  toggleField: {
1260
1296
  comment: {
@@ -1263,7 +1299,7 @@ exports.manifest = {
1263
1299
  },
1264
1300
  location: {
1265
1301
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1266
- lineNumber: 65,
1302
+ lineNumber: 68,
1267
1303
  },
1268
1304
  type: '(path: string, show: boolean) => Promise<void>',
1269
1305
  },
@@ -1274,7 +1310,7 @@ exports.manifest = {
1274
1310
  },
1275
1311
  location: {
1276
1312
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1277
- lineNumber: 80,
1313
+ lineNumber: 83,
1278
1314
  },
1279
1315
  type: '(path: string, disable: boolean) => Promise<void>',
1280
1316
  },
@@ -1285,7 +1321,7 @@ exports.manifest = {
1285
1321
  },
1286
1322
  location: {
1287
1323
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1288
- lineNumber: 97,
1324
+ lineNumber: 100,
1289
1325
  },
1290
1326
  type: '(path: string, locale?: string) => Promise<void>',
1291
1327
  },
@@ -1296,7 +1332,7 @@ exports.manifest = {
1296
1332
  },
1297
1333
  location: {
1298
1334
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1299
- lineNumber: 112,
1335
+ lineNumber: 115,
1300
1336
  },
1301
1337
  type: '(path: string, value: unknown) => Promise<void>',
1302
1338
  },
@@ -1307,7 +1343,7 @@ exports.manifest = {
1307
1343
  },
1308
1344
  location: {
1309
1345
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1310
- lineNumber: 129,
1346
+ lineNumber: 132,
1311
1347
  },
1312
1348
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
1313
1349
  },
@@ -1318,7 +1354,7 @@ exports.manifest = {
1318
1354
  },
1319
1355
  location: {
1320
1356
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1321
- lineNumber: 142,
1357
+ lineNumber: 145,
1322
1358
  },
1323
1359
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
1324
1360
  },
@@ -1329,7 +1365,7 @@ exports.manifest = {
1329
1365
  },
1330
1366
  location: {
1331
1367
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1332
- lineNumber: 154,
1368
+ lineNumber: 157,
1333
1369
  },
1334
1370
  type: '(showToast?: boolean) => Promise<void>',
1335
1371
  },
@@ -1716,6 +1752,10 @@ exports.manifest = {
1716
1752
  type: 'Ctx',
1717
1753
  additionalProperties: [
1718
1754
  {
1755
+ name: 'ItemFormAdditionalProperties',
1756
+ comment: {
1757
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1758
+ },
1719
1759
  items: {
1720
1760
  locale: {
1721
1761
  comment: {
@@ -1789,13 +1829,13 @@ exports.manifest = {
1789
1829
  },
1790
1830
  blocksAnalysis: {
1791
1831
  comment: {
1792
- comment: 'Current number of blocks present in form state',
1832
+ comment: 'Provides information on how many blocks are currently present in the form',
1793
1833
  },
1794
1834
  location: {
1795
1835
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1796
1836
  lineNumber: 29,
1797
1837
  },
1798
- 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 }',
1838
+ type: 'BlocksAnalysis',
1799
1839
  },
1800
1840
  },
1801
1841
  },
@@ -1874,6 +1914,10 @@ exports.manifest = {
1874
1914
  type: 'Ctx',
1875
1915
  additionalProperties: [
1876
1916
  {
1917
+ name: 'ItemFormAdditionalProperties',
1918
+ comment: {
1919
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1920
+ },
1877
1921
  items: {
1878
1922
  locale: {
1879
1923
  comment: {
@@ -1947,17 +1991,21 @@ exports.manifest = {
1947
1991
  },
1948
1992
  blocksAnalysis: {
1949
1993
  comment: {
1950
- comment: 'Current number of blocks present in form state',
1994
+ comment: 'Provides information on how many blocks are currently present in the form',
1951
1995
  },
1952
1996
  location: {
1953
1997
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1954
1998
  lineNumber: 29,
1955
1999
  },
1956
- 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 }',
2000
+ type: 'BlocksAnalysis',
1957
2001
  },
1958
2002
  },
1959
2003
  },
1960
2004
  {
2005
+ name: 'FieldAdditionalProperties',
2006
+ comment: {
2007
+ comment: 'These information describe the current state of the field where this plugin\nis applied to.',
2008
+ },
1961
2009
  items: {
1962
2010
  disabled: {
1963
2011
  comment: {
@@ -1965,7 +2013,7 @@ exports.manifest = {
1965
2013
  },
1966
2014
  location: {
1967
2015
  filePath: 'src/ctx/commonExtras/field.ts',
1968
- lineNumber: 8,
2016
+ lineNumber: 12,
1969
2017
  },
1970
2018
  type: 'boolean',
1971
2019
  },
@@ -1975,7 +2023,7 @@ exports.manifest = {
1975
2023
  },
1976
2024
  location: {
1977
2025
  filePath: 'src/ctx/commonExtras/field.ts',
1978
- lineNumber: 13,
2026
+ lineNumber: 17,
1979
2027
  },
1980
2028
  type: 'string',
1981
2029
  },
@@ -1985,7 +2033,7 @@ exports.manifest = {
1985
2033
  },
1986
2034
  location: {
1987
2035
  filePath: 'src/ctx/commonExtras/field.ts',
1988
- lineNumber: 15,
2036
+ lineNumber: 19,
1989
2037
  },
1990
2038
  type: 'Field',
1991
2039
  },
@@ -1995,7 +2043,7 @@ exports.manifest = {
1995
2043
  },
1996
2044
  location: {
1997
2045
  filePath: 'src/ctx/commonExtras/field.ts',
1998
- lineNumber: 20,
2046
+ lineNumber: 24,
1999
2047
  },
2000
2048
  type: 'Field | undefined',
2001
2049
  },
@@ -2005,7 +2053,7 @@ exports.manifest = {
2005
2053
  },
2006
2054
  location: {
2007
2055
  filePath: 'src/ctx/commonExtras/field.ts',
2008
- lineNumber: 26,
2056
+ lineNumber: 30,
2009
2057
  },
2010
2058
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
2011
2059
  },
@@ -2114,6 +2162,10 @@ exports.manifest = {
2114
2162
  type: 'Ctx',
2115
2163
  additionalProperties: [
2116
2164
  {
2165
+ name: 'ItemFormAdditionalProperties',
2166
+ comment: {
2167
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2168
+ },
2117
2169
  items: {
2118
2170
  locale: {
2119
2171
  comment: {
@@ -2187,13 +2239,13 @@ exports.manifest = {
2187
2239
  },
2188
2240
  blocksAnalysis: {
2189
2241
  comment: {
2190
- comment: 'Current number of blocks present in form state',
2242
+ comment: 'Provides information on how many blocks are currently present in the form',
2191
2243
  },
2192
2244
  location: {
2193
2245
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2194
2246
  lineNumber: 29,
2195
2247
  },
2196
- 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 }',
2248
+ type: 'BlocksAnalysis',
2197
2249
  },
2198
2250
  },
2199
2251
  },
@@ -2211,6 +2263,10 @@ exports.manifest = {
2211
2263
  ],
2212
2264
  additionalMethods: [
2213
2265
  {
2266
+ name: 'ItemFormAdditionalMethods',
2267
+ comment: {
2268
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2269
+ },
2214
2270
  items: {
2215
2271
  toggleField: {
2216
2272
  comment: {
@@ -2219,7 +2275,7 @@ exports.manifest = {
2219
2275
  },
2220
2276
  location: {
2221
2277
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2222
- lineNumber: 65,
2278
+ lineNumber: 68,
2223
2279
  },
2224
2280
  type: '(path: string, show: boolean) => Promise<void>',
2225
2281
  },
@@ -2230,7 +2286,7 @@ exports.manifest = {
2230
2286
  },
2231
2287
  location: {
2232
2288
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2233
- lineNumber: 80,
2289
+ lineNumber: 83,
2234
2290
  },
2235
2291
  type: '(path: string, disable: boolean) => Promise<void>',
2236
2292
  },
@@ -2241,7 +2297,7 @@ exports.manifest = {
2241
2297
  },
2242
2298
  location: {
2243
2299
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2244
- lineNumber: 97,
2300
+ lineNumber: 100,
2245
2301
  },
2246
2302
  type: '(path: string, locale?: string) => Promise<void>',
2247
2303
  },
@@ -2252,7 +2308,7 @@ exports.manifest = {
2252
2308
  },
2253
2309
  location: {
2254
2310
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2255
- lineNumber: 112,
2311
+ lineNumber: 115,
2256
2312
  },
2257
2313
  type: '(path: string, value: unknown) => Promise<void>',
2258
2314
  },
@@ -2263,7 +2319,7 @@ exports.manifest = {
2263
2319
  },
2264
2320
  location: {
2265
2321
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2266
- lineNumber: 129,
2322
+ lineNumber: 132,
2267
2323
  },
2268
2324
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
2269
2325
  },
@@ -2274,7 +2330,7 @@ exports.manifest = {
2274
2330
  },
2275
2331
  location: {
2276
2332
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2277
- lineNumber: 142,
2333
+ lineNumber: 145,
2278
2334
  },
2279
2335
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
2280
2336
  },
@@ -2285,7 +2341,7 @@ exports.manifest = {
2285
2341
  },
2286
2342
  location: {
2287
2343
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2288
- lineNumber: 154,
2344
+ lineNumber: 157,
2289
2345
  },
2290
2346
  type: '(showToast?: boolean) => Promise<void>',
2291
2347
  },
@@ -2315,6 +2371,10 @@ exports.manifest = {
2315
2371
  type: 'Ctx',
2316
2372
  additionalProperties: [
2317
2373
  {
2374
+ name: 'ItemFormAdditionalProperties',
2375
+ comment: {
2376
+ comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2377
+ },
2318
2378
  items: {
2319
2379
  locale: {
2320
2380
  comment: {
@@ -2388,17 +2448,21 @@ exports.manifest = {
2388
2448
  },
2389
2449
  blocksAnalysis: {
2390
2450
  comment: {
2391
- comment: 'Current number of blocks present in form state',
2451
+ comment: 'Provides information on how many blocks are currently present in the form',
2392
2452
  },
2393
2453
  location: {
2394
2454
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2395
2455
  lineNumber: 29,
2396
2456
  },
2397
- 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 }',
2457
+ type: 'BlocksAnalysis',
2398
2458
  },
2399
2459
  },
2400
2460
  },
2401
2461
  {
2462
+ name: 'FieldAdditionalProperties',
2463
+ comment: {
2464
+ comment: 'These information describe the current state of the field where this plugin\nis applied to.',
2465
+ },
2402
2466
  items: {
2403
2467
  disabled: {
2404
2468
  comment: {
@@ -2406,7 +2470,7 @@ exports.manifest = {
2406
2470
  },
2407
2471
  location: {
2408
2472
  filePath: 'src/ctx/commonExtras/field.ts',
2409
- lineNumber: 8,
2473
+ lineNumber: 12,
2410
2474
  },
2411
2475
  type: 'boolean',
2412
2476
  },
@@ -2416,7 +2480,7 @@ exports.manifest = {
2416
2480
  },
2417
2481
  location: {
2418
2482
  filePath: 'src/ctx/commonExtras/field.ts',
2419
- lineNumber: 13,
2483
+ lineNumber: 17,
2420
2484
  },
2421
2485
  type: 'string',
2422
2486
  },
@@ -2426,7 +2490,7 @@ exports.manifest = {
2426
2490
  },
2427
2491
  location: {
2428
2492
  filePath: 'src/ctx/commonExtras/field.ts',
2429
- lineNumber: 15,
2493
+ lineNumber: 19,
2430
2494
  },
2431
2495
  type: 'Field',
2432
2496
  },
@@ -2436,7 +2500,7 @@ exports.manifest = {
2436
2500
  },
2437
2501
  location: {
2438
2502
  filePath: 'src/ctx/commonExtras/field.ts',
2439
- lineNumber: 20,
2503
+ lineNumber: 24,
2440
2504
  },
2441
2505
  type: 'Field | undefined',
2442
2506
  },
@@ -2446,7 +2510,7 @@ exports.manifest = {
2446
2510
  },
2447
2511
  location: {
2448
2512
  filePath: 'src/ctx/commonExtras/field.ts',
2449
- lineNumber: 26,
2513
+ lineNumber: 30,
2450
2514
  },
2451
2515
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
2452
2516
  },
@@ -2466,6 +2530,10 @@ exports.manifest = {
2466
2530
  ],
2467
2531
  additionalMethods: [
2468
2532
  {
2533
+ name: 'ItemFormAdditionalMethods',
2534
+ comment: {
2535
+ comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2536
+ },
2469
2537
  items: {
2470
2538
  toggleField: {
2471
2539
  comment: {
@@ -2474,7 +2542,7 @@ exports.manifest = {
2474
2542
  },
2475
2543
  location: {
2476
2544
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2477
- lineNumber: 65,
2545
+ lineNumber: 68,
2478
2546
  },
2479
2547
  type: '(path: string, show: boolean) => Promise<void>',
2480
2548
  },
@@ -2485,7 +2553,7 @@ exports.manifest = {
2485
2553
  },
2486
2554
  location: {
2487
2555
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2488
- lineNumber: 80,
2556
+ lineNumber: 83,
2489
2557
  },
2490
2558
  type: '(path: string, disable: boolean) => Promise<void>',
2491
2559
  },
@@ -2496,7 +2564,7 @@ exports.manifest = {
2496
2564
  },
2497
2565
  location: {
2498
2566
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2499
- lineNumber: 97,
2567
+ lineNumber: 100,
2500
2568
  },
2501
2569
  type: '(path: string, locale?: string) => Promise<void>',
2502
2570
  },
@@ -2507,7 +2575,7 @@ exports.manifest = {
2507
2575
  },
2508
2576
  location: {
2509
2577
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2510
- lineNumber: 112,
2578
+ lineNumber: 115,
2511
2579
  },
2512
2580
  type: '(path: string, value: unknown) => Promise<void>',
2513
2581
  },
@@ -2518,7 +2586,7 @@ exports.manifest = {
2518
2586
  },
2519
2587
  location: {
2520
2588
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2521
- lineNumber: 129,
2589
+ lineNumber: 132,
2522
2590
  },
2523
2591
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
2524
2592
  },
@@ -2529,7 +2597,7 @@ exports.manifest = {
2529
2597
  },
2530
2598
  location: {
2531
2599
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2532
- lineNumber: 142,
2600
+ lineNumber: 145,
2533
2601
  },
2534
2602
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
2535
2603
  },
@@ -2540,7 +2608,7 @@ exports.manifest = {
2540
2608
  },
2541
2609
  location: {
2542
2610
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2543
- lineNumber: 154,
2611
+ lineNumber: 157,
2544
2612
  },
2545
2613
  type: '(showToast?: boolean) => Promise<void>',
2546
2614
  },
@@ -3135,6 +3203,10 @@ exports.manifest = {
3135
3203
  ],
3136
3204
  },
3137
3205
  selfResizingPluginFrameCtxSizingUtilities: {
3206
+ name: 'SizingUtilities',
3207
+ comment: {
3208
+ comment: 'A number of methods that you can use to control the size of the plugin frame',
3209
+ },
3138
3210
  items: {
3139
3211
  startAutoResizer: {
3140
3212
  comment: {
@@ -3142,7 +3214,7 @@ exports.manifest = {
3142
3214
  },
3143
3215
  location: {
3144
3216
  filePath: 'src/ctx/commonExtras/sizing.ts',
3145
- lineNumber: 7,
3217
+ lineNumber: 8,
3146
3218
  },
3147
3219
  type: '() => void',
3148
3220
  },
@@ -3152,7 +3224,7 @@ exports.manifest = {
3152
3224
  },
3153
3225
  location: {
3154
3226
  filePath: 'src/ctx/commonExtras/sizing.ts',
3155
- lineNumber: 10,
3227
+ lineNumber: 11,
3156
3228
  },
3157
3229
  type: '() => void',
3158
3230
  },
@@ -3162,7 +3234,7 @@ exports.manifest = {
3162
3234
  },
3163
3235
  location: {
3164
3236
  filePath: 'src/ctx/commonExtras/sizing.ts',
3165
- lineNumber: 17,
3237
+ lineNumber: 18,
3166
3238
  },
3167
3239
  type: '(newHeight?: number) => void',
3168
3240
  },