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/src/manifest.ts CHANGED
@@ -445,6 +445,11 @@ export const manifest: Manifest = {
445
445
  type: 'SelfResizingPluginFrameCtx',
446
446
  additionalProperties: [
447
447
  {
448
+ name: 'ItemFormAdditionalProperties',
449
+ comment: {
450
+ comment:
451
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
452
+ },
448
453
  items: {
449
454
  locale: {
450
455
  comment: {
@@ -521,13 +526,14 @@ export const manifest: Manifest = {
521
526
  },
522
527
  blocksAnalysis: {
523
528
  comment: {
524
- comment: 'Current number of blocks present in form state',
529
+ comment:
530
+ 'Provides information on how many blocks are currently present in the form',
525
531
  },
526
532
  location: {
527
533
  filePath: 'src/ctx/commonExtras/itemForm.ts',
528
534
  lineNumber: 29,
529
535
  },
530
- 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 }',
536
+ type: 'BlocksAnalysis',
531
537
  },
532
538
  },
533
539
  },
@@ -560,6 +566,11 @@ export const manifest: Manifest = {
560
566
  ],
561
567
  additionalMethods: [
562
568
  {
569
+ name: 'ItemFormAdditionalMethods',
570
+ comment: {
571
+ comment:
572
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
573
+ },
563
574
  items: {
564
575
  toggleField: {
565
576
  comment: {
@@ -570,7 +581,7 @@ export const manifest: Manifest = {
570
581
  },
571
582
  location: {
572
583
  filePath: 'src/ctx/commonExtras/itemForm.ts',
573
- lineNumber: 65,
584
+ lineNumber: 68,
574
585
  },
575
586
  type: '(path: string, show: boolean) => Promise<void>',
576
587
  },
@@ -582,7 +593,7 @@ export const manifest: Manifest = {
582
593
  },
583
594
  location: {
584
595
  filePath: 'src/ctx/commonExtras/itemForm.ts',
585
- lineNumber: 80,
596
+ lineNumber: 83,
586
597
  },
587
598
  type: '(path: string, disable: boolean) => Promise<void>',
588
599
  },
@@ -595,7 +606,7 @@ export const manifest: Manifest = {
595
606
  },
596
607
  location: {
597
608
  filePath: 'src/ctx/commonExtras/itemForm.ts',
598
- lineNumber: 97,
609
+ lineNumber: 100,
599
610
  },
600
611
  type: '(path: string, locale?: string) => Promise<void>',
601
612
  },
@@ -607,7 +618,7 @@ export const manifest: Manifest = {
607
618
  },
608
619
  location: {
609
620
  filePath: 'src/ctx/commonExtras/itemForm.ts',
610
- lineNumber: 112,
621
+ lineNumber: 115,
611
622
  },
612
623
  type: '(path: string, value: unknown) => Promise<void>',
613
624
  },
@@ -619,7 +630,7 @@ export const manifest: Manifest = {
619
630
  },
620
631
  location: {
621
632
  filePath: 'src/ctx/commonExtras/itemForm.ts',
622
- lineNumber: 129,
633
+ lineNumber: 132,
623
634
  },
624
635
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
625
636
  },
@@ -631,7 +642,7 @@ export const manifest: Manifest = {
631
642
  },
632
643
  location: {
633
644
  filePath: 'src/ctx/commonExtras/itemForm.ts',
634
- lineNumber: 142,
645
+ lineNumber: 145,
635
646
  },
636
647
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
637
648
  },
@@ -642,7 +653,7 @@ export const manifest: Manifest = {
642
653
  },
643
654
  location: {
644
655
  filePath: 'src/ctx/commonExtras/itemForm.ts',
645
- lineNumber: 154,
656
+ lineNumber: 157,
646
657
  },
647
658
  type: '(showToast?: boolean) => Promise<void>',
648
659
  },
@@ -673,6 +684,11 @@ export const manifest: Manifest = {
673
684
  type: 'ImposedSizePluginFrameCtx',
674
685
  additionalProperties: [
675
686
  {
687
+ name: 'ItemFormAdditionalProperties',
688
+ comment: {
689
+ comment:
690
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
691
+ },
676
692
  items: {
677
693
  locale: {
678
694
  comment: {
@@ -749,13 +765,14 @@ export const manifest: Manifest = {
749
765
  },
750
766
  blocksAnalysis: {
751
767
  comment: {
752
- comment: 'Current number of blocks present in form state',
768
+ comment:
769
+ 'Provides information on how many blocks are currently present in the form',
753
770
  },
754
771
  location: {
755
772
  filePath: 'src/ctx/commonExtras/itemForm.ts',
756
773
  lineNumber: 29,
757
774
  },
758
- 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 }',
775
+ type: 'BlocksAnalysis',
759
776
  },
760
777
  },
761
778
  },
@@ -787,6 +804,11 @@ export const manifest: Manifest = {
787
804
  ],
788
805
  additionalMethods: [
789
806
  {
807
+ name: 'ItemFormAdditionalMethods',
808
+ comment: {
809
+ comment:
810
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
811
+ },
790
812
  items: {
791
813
  toggleField: {
792
814
  comment: {
@@ -797,7 +819,7 @@ export const manifest: Manifest = {
797
819
  },
798
820
  location: {
799
821
  filePath: 'src/ctx/commonExtras/itemForm.ts',
800
- lineNumber: 65,
822
+ lineNumber: 68,
801
823
  },
802
824
  type: '(path: string, show: boolean) => Promise<void>',
803
825
  },
@@ -809,7 +831,7 @@ export const manifest: Manifest = {
809
831
  },
810
832
  location: {
811
833
  filePath: 'src/ctx/commonExtras/itemForm.ts',
812
- lineNumber: 80,
834
+ lineNumber: 83,
813
835
  },
814
836
  type: '(path: string, disable: boolean) => Promise<void>',
815
837
  },
@@ -822,7 +844,7 @@ export const manifest: Manifest = {
822
844
  },
823
845
  location: {
824
846
  filePath: 'src/ctx/commonExtras/itemForm.ts',
825
- lineNumber: 97,
847
+ lineNumber: 100,
826
848
  },
827
849
  type: '(path: string, locale?: string) => Promise<void>',
828
850
  },
@@ -834,7 +856,7 @@ export const manifest: Manifest = {
834
856
  },
835
857
  location: {
836
858
  filePath: 'src/ctx/commonExtras/itemForm.ts',
837
- lineNumber: 112,
859
+ lineNumber: 115,
838
860
  },
839
861
  type: '(path: string, value: unknown) => Promise<void>',
840
862
  },
@@ -846,7 +868,7 @@ export const manifest: Manifest = {
846
868
  },
847
869
  location: {
848
870
  filePath: 'src/ctx/commonExtras/itemForm.ts',
849
- lineNumber: 129,
871
+ lineNumber: 132,
850
872
  },
851
873
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
852
874
  },
@@ -858,7 +880,7 @@ export const manifest: Manifest = {
858
880
  },
859
881
  location: {
860
882
  filePath: 'src/ctx/commonExtras/itemForm.ts',
861
- lineNumber: 142,
883
+ lineNumber: 145,
862
884
  },
863
885
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
864
886
  },
@@ -869,7 +891,7 @@ export const manifest: Manifest = {
869
891
  },
870
892
  location: {
871
893
  filePath: 'src/ctx/commonExtras/itemForm.ts',
872
- lineNumber: 154,
894
+ lineNumber: 157,
873
895
  },
874
896
  type: '(showToast?: boolean) => Promise<void>',
875
897
  },
@@ -900,6 +922,11 @@ export const manifest: Manifest = {
900
922
  type: 'SelfResizingPluginFrameCtx',
901
923
  additionalProperties: [
902
924
  {
925
+ name: 'ItemFormAdditionalProperties',
926
+ comment: {
927
+ comment:
928
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
929
+ },
903
930
  items: {
904
931
  locale: {
905
932
  comment: {
@@ -976,13 +1003,14 @@ export const manifest: Manifest = {
976
1003
  },
977
1004
  blocksAnalysis: {
978
1005
  comment: {
979
- comment: 'Current number of blocks present in form state',
1006
+ comment:
1007
+ 'Provides information on how many blocks are currently present in the form',
980
1008
  },
981
1009
  location: {
982
1010
  filePath: 'src/ctx/commonExtras/itemForm.ts',
983
1011
  lineNumber: 29,
984
1012
  },
985
- 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 }',
1013
+ type: 'BlocksAnalysis',
986
1014
  },
987
1015
  },
988
1016
  },
@@ -1003,6 +1031,11 @@ export const manifest: Manifest = {
1003
1031
  ],
1004
1032
  additionalMethods: [
1005
1033
  {
1034
+ name: 'ItemFormAdditionalMethods',
1035
+ comment: {
1036
+ comment:
1037
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
1038
+ },
1006
1039
  items: {
1007
1040
  toggleField: {
1008
1041
  comment: {
@@ -1013,7 +1046,7 @@ export const manifest: Manifest = {
1013
1046
  },
1014
1047
  location: {
1015
1048
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1016
- lineNumber: 65,
1049
+ lineNumber: 68,
1017
1050
  },
1018
1051
  type: '(path: string, show: boolean) => Promise<void>',
1019
1052
  },
@@ -1025,7 +1058,7 @@ export const manifest: Manifest = {
1025
1058
  },
1026
1059
  location: {
1027
1060
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1028
- lineNumber: 80,
1061
+ lineNumber: 83,
1029
1062
  },
1030
1063
  type: '(path: string, disable: boolean) => Promise<void>',
1031
1064
  },
@@ -1038,7 +1071,7 @@ export const manifest: Manifest = {
1038
1071
  },
1039
1072
  location: {
1040
1073
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1041
- lineNumber: 97,
1074
+ lineNumber: 100,
1042
1075
  },
1043
1076
  type: '(path: string, locale?: string) => Promise<void>',
1044
1077
  },
@@ -1050,7 +1083,7 @@ export const manifest: Manifest = {
1050
1083
  },
1051
1084
  location: {
1052
1085
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1053
- lineNumber: 112,
1086
+ lineNumber: 115,
1054
1087
  },
1055
1088
  type: '(path: string, value: unknown) => Promise<void>',
1056
1089
  },
@@ -1062,7 +1095,7 @@ export const manifest: Manifest = {
1062
1095
  },
1063
1096
  location: {
1064
1097
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1065
- lineNumber: 129,
1098
+ lineNumber: 132,
1066
1099
  },
1067
1100
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
1068
1101
  },
@@ -1074,7 +1107,7 @@ export const manifest: Manifest = {
1074
1107
  },
1075
1108
  location: {
1076
1109
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1077
- lineNumber: 142,
1110
+ lineNumber: 145,
1078
1111
  },
1079
1112
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
1080
1113
  },
@@ -1085,7 +1118,7 @@ export const manifest: Manifest = {
1085
1118
  },
1086
1119
  location: {
1087
1120
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1088
- lineNumber: 154,
1121
+ lineNumber: 157,
1089
1122
  },
1090
1123
  type: '(showToast?: boolean) => Promise<void>',
1091
1124
  },
@@ -1155,6 +1188,11 @@ export const manifest: Manifest = {
1155
1188
  type: 'SelfResizingPluginFrameCtx',
1156
1189
  additionalProperties: [
1157
1190
  {
1191
+ name: 'ItemFormAdditionalProperties',
1192
+ comment: {
1193
+ comment:
1194
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1195
+ },
1158
1196
  items: {
1159
1197
  locale: {
1160
1198
  comment: {
@@ -1231,17 +1269,23 @@ export const manifest: Manifest = {
1231
1269
  },
1232
1270
  blocksAnalysis: {
1233
1271
  comment: {
1234
- comment: 'Current number of blocks present in form state',
1272
+ comment:
1273
+ 'Provides information on how many blocks are currently present in the form',
1235
1274
  },
1236
1275
  location: {
1237
1276
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1238
1277
  lineNumber: 29,
1239
1278
  },
1240
- 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 }',
1279
+ type: 'BlocksAnalysis',
1241
1280
  },
1242
1281
  },
1243
1282
  },
1244
1283
  {
1284
+ name: 'FieldAdditionalProperties',
1285
+ comment: {
1286
+ comment:
1287
+ 'These information describe the current state of the field where this plugin\nis applied to.',
1288
+ },
1245
1289
  items: {
1246
1290
  disabled: {
1247
1291
  comment: {
@@ -1249,7 +1293,7 @@ export const manifest: Manifest = {
1249
1293
  },
1250
1294
  location: {
1251
1295
  filePath: 'src/ctx/commonExtras/field.ts',
1252
- lineNumber: 8,
1296
+ lineNumber: 12,
1253
1297
  },
1254
1298
  type: 'boolean',
1255
1299
  },
@@ -1260,7 +1304,7 @@ export const manifest: Manifest = {
1260
1304
  },
1261
1305
  location: {
1262
1306
  filePath: 'src/ctx/commonExtras/field.ts',
1263
- lineNumber: 13,
1307
+ lineNumber: 17,
1264
1308
  },
1265
1309
  type: 'string',
1266
1310
  },
@@ -1271,7 +1315,7 @@ export const manifest: Manifest = {
1271
1315
  },
1272
1316
  location: {
1273
1317
  filePath: 'src/ctx/commonExtras/field.ts',
1274
- lineNumber: 15,
1318
+ lineNumber: 19,
1275
1319
  },
1276
1320
  type: 'Field',
1277
1321
  },
@@ -1282,7 +1326,7 @@ export const manifest: Manifest = {
1282
1326
  },
1283
1327
  location: {
1284
1328
  filePath: 'src/ctx/commonExtras/field.ts',
1285
- lineNumber: 20,
1329
+ lineNumber: 24,
1286
1330
  },
1287
1331
  type: 'Field | undefined',
1288
1332
  },
@@ -1293,7 +1337,7 @@ export const manifest: Manifest = {
1293
1337
  },
1294
1338
  location: {
1295
1339
  filePath: 'src/ctx/commonExtras/field.ts',
1296
- lineNumber: 26,
1340
+ lineNumber: 30,
1297
1341
  },
1298
1342
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
1299
1343
  },
@@ -1327,6 +1371,11 @@ export const manifest: Manifest = {
1327
1371
  ],
1328
1372
  additionalMethods: [
1329
1373
  {
1374
+ name: 'ItemFormAdditionalMethods',
1375
+ comment: {
1376
+ comment:
1377
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
1378
+ },
1330
1379
  items: {
1331
1380
  toggleField: {
1332
1381
  comment: {
@@ -1337,7 +1386,7 @@ export const manifest: Manifest = {
1337
1386
  },
1338
1387
  location: {
1339
1388
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1340
- lineNumber: 65,
1389
+ lineNumber: 68,
1341
1390
  },
1342
1391
  type: '(path: string, show: boolean) => Promise<void>',
1343
1392
  },
@@ -1349,7 +1398,7 @@ export const manifest: Manifest = {
1349
1398
  },
1350
1399
  location: {
1351
1400
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1352
- lineNumber: 80,
1401
+ lineNumber: 83,
1353
1402
  },
1354
1403
  type: '(path: string, disable: boolean) => Promise<void>',
1355
1404
  },
@@ -1362,7 +1411,7 @@ export const manifest: Manifest = {
1362
1411
  },
1363
1412
  location: {
1364
1413
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1365
- lineNumber: 97,
1414
+ lineNumber: 100,
1366
1415
  },
1367
1416
  type: '(path: string, locale?: string) => Promise<void>',
1368
1417
  },
@@ -1374,7 +1423,7 @@ export const manifest: Manifest = {
1374
1423
  },
1375
1424
  location: {
1376
1425
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1377
- lineNumber: 112,
1426
+ lineNumber: 115,
1378
1427
  },
1379
1428
  type: '(path: string, value: unknown) => Promise<void>',
1380
1429
  },
@@ -1386,7 +1435,7 @@ export const manifest: Manifest = {
1386
1435
  },
1387
1436
  location: {
1388
1437
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1389
- lineNumber: 129,
1438
+ lineNumber: 132,
1390
1439
  },
1391
1440
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
1392
1441
  },
@@ -1398,7 +1447,7 @@ export const manifest: Manifest = {
1398
1447
  },
1399
1448
  location: {
1400
1449
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1401
- lineNumber: 142,
1450
+ lineNumber: 145,
1402
1451
  },
1403
1452
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
1404
1453
  },
@@ -1409,7 +1458,7 @@ export const manifest: Manifest = {
1409
1458
  },
1410
1459
  location: {
1411
1460
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1412
- lineNumber: 154,
1461
+ lineNumber: 157,
1413
1462
  },
1414
1463
  type: '(showToast?: boolean) => Promise<void>',
1415
1464
  },
@@ -1814,6 +1863,11 @@ export const manifest: Manifest = {
1814
1863
  type: 'Ctx',
1815
1864
  additionalProperties: [
1816
1865
  {
1866
+ name: 'ItemFormAdditionalProperties',
1867
+ comment: {
1868
+ comment:
1869
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1870
+ },
1817
1871
  items: {
1818
1872
  locale: {
1819
1873
  comment: {
@@ -1890,13 +1944,14 @@ export const manifest: Manifest = {
1890
1944
  },
1891
1945
  blocksAnalysis: {
1892
1946
  comment: {
1893
- comment: 'Current number of blocks present in form state',
1947
+ comment:
1948
+ 'Provides information on how many blocks are currently present in the form',
1894
1949
  },
1895
1950
  location: {
1896
1951
  filePath: 'src/ctx/commonExtras/itemForm.ts',
1897
1952
  lineNumber: 29,
1898
1953
  },
1899
- 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 }',
1954
+ type: 'BlocksAnalysis',
1900
1955
  },
1901
1956
  },
1902
1957
  },
@@ -1979,6 +2034,11 @@ export const manifest: Manifest = {
1979
2034
  type: 'Ctx',
1980
2035
  additionalProperties: [
1981
2036
  {
2037
+ name: 'ItemFormAdditionalProperties',
2038
+ comment: {
2039
+ comment:
2040
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2041
+ },
1982
2042
  items: {
1983
2043
  locale: {
1984
2044
  comment: {
@@ -2055,17 +2115,23 @@ export const manifest: Manifest = {
2055
2115
  },
2056
2116
  blocksAnalysis: {
2057
2117
  comment: {
2058
- comment: 'Current number of blocks present in form state',
2118
+ comment:
2119
+ 'Provides information on how many blocks are currently present in the form',
2059
2120
  },
2060
2121
  location: {
2061
2122
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2062
2123
  lineNumber: 29,
2063
2124
  },
2064
- 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 }',
2125
+ type: 'BlocksAnalysis',
2065
2126
  },
2066
2127
  },
2067
2128
  },
2068
2129
  {
2130
+ name: 'FieldAdditionalProperties',
2131
+ comment: {
2132
+ comment:
2133
+ 'These information describe the current state of the field where this plugin\nis applied to.',
2134
+ },
2069
2135
  items: {
2070
2136
  disabled: {
2071
2137
  comment: {
@@ -2073,7 +2139,7 @@ export const manifest: Manifest = {
2073
2139
  },
2074
2140
  location: {
2075
2141
  filePath: 'src/ctx/commonExtras/field.ts',
2076
- lineNumber: 8,
2142
+ lineNumber: 12,
2077
2143
  },
2078
2144
  type: 'boolean',
2079
2145
  },
@@ -2084,7 +2150,7 @@ export const manifest: Manifest = {
2084
2150
  },
2085
2151
  location: {
2086
2152
  filePath: 'src/ctx/commonExtras/field.ts',
2087
- lineNumber: 13,
2153
+ lineNumber: 17,
2088
2154
  },
2089
2155
  type: 'string',
2090
2156
  },
@@ -2095,7 +2161,7 @@ export const manifest: Manifest = {
2095
2161
  },
2096
2162
  location: {
2097
2163
  filePath: 'src/ctx/commonExtras/field.ts',
2098
- lineNumber: 15,
2164
+ lineNumber: 19,
2099
2165
  },
2100
2166
  type: 'Field',
2101
2167
  },
@@ -2106,7 +2172,7 @@ export const manifest: Manifest = {
2106
2172
  },
2107
2173
  location: {
2108
2174
  filePath: 'src/ctx/commonExtras/field.ts',
2109
- lineNumber: 20,
2175
+ lineNumber: 24,
2110
2176
  },
2111
2177
  type: 'Field | undefined',
2112
2178
  },
@@ -2117,7 +2183,7 @@ export const manifest: Manifest = {
2117
2183
  },
2118
2184
  location: {
2119
2185
  filePath: 'src/ctx/commonExtras/field.ts',
2120
- lineNumber: 26,
2186
+ lineNumber: 30,
2121
2187
  },
2122
2188
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
2123
2189
  },
@@ -2229,6 +2295,11 @@ export const manifest: Manifest = {
2229
2295
  type: 'Ctx',
2230
2296
  additionalProperties: [
2231
2297
  {
2298
+ name: 'ItemFormAdditionalProperties',
2299
+ comment: {
2300
+ comment:
2301
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2302
+ },
2232
2303
  items: {
2233
2304
  locale: {
2234
2305
  comment: {
@@ -2305,13 +2376,14 @@ export const manifest: Manifest = {
2305
2376
  },
2306
2377
  blocksAnalysis: {
2307
2378
  comment: {
2308
- comment: 'Current number of blocks present in form state',
2379
+ comment:
2380
+ 'Provides information on how many blocks are currently present in the form',
2309
2381
  },
2310
2382
  location: {
2311
2383
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2312
2384
  lineNumber: 29,
2313
2385
  },
2314
- 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 }',
2386
+ type: 'BlocksAnalysis',
2315
2387
  },
2316
2388
  },
2317
2389
  },
@@ -2329,6 +2401,11 @@ export const manifest: Manifest = {
2329
2401
  ],
2330
2402
  additionalMethods: [
2331
2403
  {
2404
+ name: 'ItemFormAdditionalMethods',
2405
+ comment: {
2406
+ comment:
2407
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2408
+ },
2332
2409
  items: {
2333
2410
  toggleField: {
2334
2411
  comment: {
@@ -2339,7 +2416,7 @@ export const manifest: Manifest = {
2339
2416
  },
2340
2417
  location: {
2341
2418
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2342
- lineNumber: 65,
2419
+ lineNumber: 68,
2343
2420
  },
2344
2421
  type: '(path: string, show: boolean) => Promise<void>',
2345
2422
  },
@@ -2351,7 +2428,7 @@ export const manifest: Manifest = {
2351
2428
  },
2352
2429
  location: {
2353
2430
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2354
- lineNumber: 80,
2431
+ lineNumber: 83,
2355
2432
  },
2356
2433
  type: '(path: string, disable: boolean) => Promise<void>',
2357
2434
  },
@@ -2364,7 +2441,7 @@ export const manifest: Manifest = {
2364
2441
  },
2365
2442
  location: {
2366
2443
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2367
- lineNumber: 97,
2444
+ lineNumber: 100,
2368
2445
  },
2369
2446
  type: '(path: string, locale?: string) => Promise<void>',
2370
2447
  },
@@ -2376,7 +2453,7 @@ export const manifest: Manifest = {
2376
2453
  },
2377
2454
  location: {
2378
2455
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2379
- lineNumber: 112,
2456
+ lineNumber: 115,
2380
2457
  },
2381
2458
  type: '(path: string, value: unknown) => Promise<void>',
2382
2459
  },
@@ -2388,7 +2465,7 @@ export const manifest: Manifest = {
2388
2465
  },
2389
2466
  location: {
2390
2467
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2391
- lineNumber: 129,
2468
+ lineNumber: 132,
2392
2469
  },
2393
2470
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
2394
2471
  },
@@ -2400,7 +2477,7 @@ export const manifest: Manifest = {
2400
2477
  },
2401
2478
  location: {
2402
2479
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2403
- lineNumber: 142,
2480
+ lineNumber: 145,
2404
2481
  },
2405
2482
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
2406
2483
  },
@@ -2411,7 +2488,7 @@ export const manifest: Manifest = {
2411
2488
  },
2412
2489
  location: {
2413
2490
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2414
- lineNumber: 154,
2491
+ lineNumber: 157,
2415
2492
  },
2416
2493
  type: '(showToast?: boolean) => Promise<void>',
2417
2494
  },
@@ -2442,6 +2519,11 @@ export const manifest: Manifest = {
2442
2519
  type: 'Ctx',
2443
2520
  additionalProperties: [
2444
2521
  {
2522
+ name: 'ItemFormAdditionalProperties',
2523
+ comment: {
2524
+ comment:
2525
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2526
+ },
2445
2527
  items: {
2446
2528
  locale: {
2447
2529
  comment: {
@@ -2518,17 +2600,23 @@ export const manifest: Manifest = {
2518
2600
  },
2519
2601
  blocksAnalysis: {
2520
2602
  comment: {
2521
- comment: 'Current number of blocks present in form state',
2603
+ comment:
2604
+ 'Provides information on how many blocks are currently present in the form',
2522
2605
  },
2523
2606
  location: {
2524
2607
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2525
2608
  lineNumber: 29,
2526
2609
  },
2527
- 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 }',
2610
+ type: 'BlocksAnalysis',
2528
2611
  },
2529
2612
  },
2530
2613
  },
2531
2614
  {
2615
+ name: 'FieldAdditionalProperties',
2616
+ comment: {
2617
+ comment:
2618
+ 'These information describe the current state of the field where this plugin\nis applied to.',
2619
+ },
2532
2620
  items: {
2533
2621
  disabled: {
2534
2622
  comment: {
@@ -2536,7 +2624,7 @@ export const manifest: Manifest = {
2536
2624
  },
2537
2625
  location: {
2538
2626
  filePath: 'src/ctx/commonExtras/field.ts',
2539
- lineNumber: 8,
2627
+ lineNumber: 12,
2540
2628
  },
2541
2629
  type: 'boolean',
2542
2630
  },
@@ -2547,7 +2635,7 @@ export const manifest: Manifest = {
2547
2635
  },
2548
2636
  location: {
2549
2637
  filePath: 'src/ctx/commonExtras/field.ts',
2550
- lineNumber: 13,
2638
+ lineNumber: 17,
2551
2639
  },
2552
2640
  type: 'string',
2553
2641
  },
@@ -2558,7 +2646,7 @@ export const manifest: Manifest = {
2558
2646
  },
2559
2647
  location: {
2560
2648
  filePath: 'src/ctx/commonExtras/field.ts',
2561
- lineNumber: 15,
2649
+ lineNumber: 19,
2562
2650
  },
2563
2651
  type: 'Field',
2564
2652
  },
@@ -2569,7 +2657,7 @@ export const manifest: Manifest = {
2569
2657
  },
2570
2658
  location: {
2571
2659
  filePath: 'src/ctx/commonExtras/field.ts',
2572
- lineNumber: 20,
2660
+ lineNumber: 24,
2573
2661
  },
2574
2662
  type: 'Field | undefined',
2575
2663
  },
@@ -2580,7 +2668,7 @@ export const manifest: Manifest = {
2580
2668
  },
2581
2669
  location: {
2582
2670
  filePath: 'src/ctx/commonExtras/field.ts',
2583
- lineNumber: 26,
2671
+ lineNumber: 30,
2584
2672
  },
2585
2673
  type: 'undefined | { id: string | undefined; blockModel: ItemType }',
2586
2674
  },
@@ -2600,6 +2688,11 @@ export const manifest: Manifest = {
2600
2688
  ],
2601
2689
  additionalMethods: [
2602
2690
  {
2691
+ name: 'ItemFormAdditionalMethods',
2692
+ comment: {
2693
+ comment:
2694
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2695
+ },
2603
2696
  items: {
2604
2697
  toggleField: {
2605
2698
  comment: {
@@ -2610,7 +2703,7 @@ export const manifest: Manifest = {
2610
2703
  },
2611
2704
  location: {
2612
2705
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2613
- lineNumber: 65,
2706
+ lineNumber: 68,
2614
2707
  },
2615
2708
  type: '(path: string, show: boolean) => Promise<void>',
2616
2709
  },
@@ -2622,7 +2715,7 @@ export const manifest: Manifest = {
2622
2715
  },
2623
2716
  location: {
2624
2717
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2625
- lineNumber: 80,
2718
+ lineNumber: 83,
2626
2719
  },
2627
2720
  type: '(path: string, disable: boolean) => Promise<void>',
2628
2721
  },
@@ -2635,7 +2728,7 @@ export const manifest: Manifest = {
2635
2728
  },
2636
2729
  location: {
2637
2730
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2638
- lineNumber: 97,
2731
+ lineNumber: 100,
2639
2732
  },
2640
2733
  type: '(path: string, locale?: string) => Promise<void>',
2641
2734
  },
@@ -2647,7 +2740,7 @@ export const manifest: Manifest = {
2647
2740
  },
2648
2741
  location: {
2649
2742
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2650
- lineNumber: 112,
2743
+ lineNumber: 115,
2651
2744
  },
2652
2745
  type: '(path: string, value: unknown) => Promise<void>',
2653
2746
  },
@@ -2659,7 +2752,7 @@ export const manifest: Manifest = {
2659
2752
  },
2660
2753
  location: {
2661
2754
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2662
- lineNumber: 129,
2755
+ lineNumber: 132,
2663
2756
  },
2664
2757
  type: "(\n formValues: Record<string, unknown>,\n skipUnchangedFields?: boolean,\n ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>",
2665
2758
  },
@@ -2671,7 +2764,7 @@ export const manifest: Manifest = {
2671
2764
  },
2672
2765
  location: {
2673
2766
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2674
- lineNumber: 142,
2767
+ lineNumber: 145,
2675
2768
  },
2676
2769
  type: "(\n item: Omit<Item, 'id' | 'meta'>,\n ) => Promise<Record<string, unknown>>",
2677
2770
  },
@@ -2682,7 +2775,7 @@ export const manifest: Manifest = {
2682
2775
  },
2683
2776
  location: {
2684
2777
  filePath: 'src/ctx/commonExtras/itemForm.ts',
2685
- lineNumber: 154,
2778
+ lineNumber: 157,
2686
2779
  },
2687
2780
  type: '(showToast?: boolean) => Promise<void>',
2688
2781
  },
@@ -3337,6 +3430,11 @@ export const manifest: Manifest = {
3337
3430
  ],
3338
3431
  },
3339
3432
  selfResizingPluginFrameCtxSizingUtilities: {
3433
+ name: 'SizingUtilities',
3434
+ comment: {
3435
+ comment:
3436
+ 'A number of methods that you can use to control the size of the plugin frame',
3437
+ },
3340
3438
  items: {
3341
3439
  startAutoResizer: {
3342
3440
  comment: {
@@ -3345,7 +3443,7 @@ export const manifest: Manifest = {
3345
3443
  },
3346
3444
  location: {
3347
3445
  filePath: 'src/ctx/commonExtras/sizing.ts',
3348
- lineNumber: 7,
3446
+ lineNumber: 8,
3349
3447
  },
3350
3448
  type: '() => void',
3351
3449
  },
@@ -3355,7 +3453,7 @@ export const manifest: Manifest = {
3355
3453
  },
3356
3454
  location: {
3357
3455
  filePath: 'src/ctx/commonExtras/sizing.ts',
3358
- lineNumber: 10,
3456
+ lineNumber: 11,
3359
3457
  },
3360
3458
  type: '() => void',
3361
3459
  },
@@ -3366,7 +3464,7 @@ export const manifest: Manifest = {
3366
3464
  },
3367
3465
  location: {
3368
3466
  filePath: 'src/ctx/commonExtras/sizing.ts',
3369
- lineNumber: 17,
3467
+ lineNumber: 18,
3370
3468
  },
3371
3469
  type: '(newHeight?: number) => void',
3372
3470
  },