| 1 | {
|
| 2 | "id": 0,
|
| 3 | "name": "datocms-plugin-sdk",
|
| 4 | "kind": 1,
|
| 5 | "kindString": "Project",
|
| 6 | "flags": {},
|
| 7 | "originalName": "",
|
| 8 | "children": [
|
| 9 | {
|
| 10 | "id": 1,
|
| 11 | "name": "Account",
|
| 12 | "kind": 256,
|
| 13 | "kindString": "Interface",
|
| 14 | "flags": {},
|
| 15 | "comment": {
|
| 16 | "shortText": "DatoCMS account",
|
| 17 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"account\".\n"
|
| 18 | },
|
| 19 | "children": [
|
| 20 | {
|
| 21 | "id": 4,
|
| 22 | "name": "attributes",
|
| 23 | "kind": 1024,
|
| 24 | "kindString": "Property",
|
| 25 | "flags": {},
|
| 26 | "sources": [
|
| 27 | {
|
| 28 | "fileName": "SiteApiSchema.ts",
|
| 29 | "line": 1929,
|
| 30 | "character": 2
|
| 31 | }
|
| 32 | ],
|
| 33 | "type": {
|
| 34 | "type": "reference",
|
| 35 | "name": "AccountAttributes"
|
| 36 | }
|
| 37 | },
|
| 38 | {
|
| 39 | "id": 3,
|
| 40 | "name": "id",
|
| 41 | "kind": 1024,
|
| 42 | "kindString": "Property",
|
| 43 | "flags": {},
|
| 44 | "sources": [
|
| 45 | {
|
| 46 | "fileName": "SiteApiSchema.ts",
|
| 47 | "line": 1928,
|
| 48 | "character": 2
|
| 49 | }
|
| 50 | ],
|
| 51 | "type": {
|
| 52 | "type": "intrinsic",
|
| 53 | "name": "string"
|
| 54 | }
|
| 55 | },
|
| 56 | {
|
| 57 | "id": 2,
|
| 58 | "name": "type",
|
| 59 | "kind": 1024,
|
| 60 | "kindString": "Property",
|
| 61 | "flags": {},
|
| 62 | "sources": [
|
| 63 | {
|
| 64 | "fileName": "SiteApiSchema.ts",
|
| 65 | "line": 1927,
|
| 66 | "character": 2
|
| 67 | }
|
| 68 | ],
|
| 69 | "type": {
|
| 70 | "type": "literal",
|
| 71 | "value": "account"
|
| 72 | }
|
| 73 | }
|
| 74 | ],
|
| 75 | "groups": [
|
| 76 | {
|
| 77 | "title": "Properties",
|
| 78 | "kind": 1024,
|
| 79 | "children": [
|
| 80 | 4,
|
| 81 | 3,
|
| 82 | 2
|
| 83 | ]
|
| 84 | }
|
| 85 | ],
|
| 86 | "sources": [
|
| 87 | {
|
| 88 | "fileName": "SiteApiSchema.ts",
|
| 89 | "line": 1926,
|
| 90 | "character": 17
|
| 91 | }
|
| 92 | ]
|
| 93 | },
|
| 94 | {
|
| 95 | "id": 5,
|
| 96 | "name": "Field",
|
| 97 | "kind": 256,
|
| 98 | "kindString": "Interface",
|
| 99 | "flags": {},
|
| 100 | "comment": {
|
| 101 | "shortText": "Each Model consists of a set of fields. Using the database metaphore, fields are like\ntable columns, and when creating them you need to specify their type (`string`,\n`file`, `float`, etc.) and any required validation.",
|
| 102 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"field\".\n"
|
| 103 | },
|
| 104 | "children": [
|
| 105 | {
|
| 106 | "id": 8,
|
| 107 | "name": "attributes",
|
| 108 | "kind": 1024,
|
| 109 | "kindString": "Property",
|
| 110 | "flags": {},
|
| 111 | "sources": [
|
| 112 | {
|
| 113 | "fileName": "SiteApiSchema.ts",
|
| 114 | "line": 2539,
|
| 115 | "character": 2
|
| 116 | }
|
| 117 | ],
|
| 118 | "type": {
|
| 119 | "type": "reference",
|
| 120 | "name": "FieldAttributes"
|
| 121 | }
|
| 122 | },
|
| 123 | {
|
| 124 | "id": 7,
|
| 125 | "name": "id",
|
| 126 | "kind": 1024,
|
| 127 | "kindString": "Property",
|
| 128 | "flags": {},
|
| 129 | "sources": [
|
| 130 | {
|
| 131 | "fileName": "SiteApiSchema.ts",
|
| 132 | "line": 2538,
|
| 133 | "character": 2
|
| 134 | }
|
| 135 | ],
|
| 136 | "type": {
|
| 137 | "type": "intrinsic",
|
| 138 | "name": "string"
|
| 139 | }
|
| 140 | },
|
| 141 | {
|
| 142 | "id": 9,
|
| 143 | "name": "relationships",
|
| 144 | "kind": 1024,
|
| 145 | "kindString": "Property",
|
| 146 | "flags": {},
|
| 147 | "sources": [
|
| 148 | {
|
| 149 | "fileName": "SiteApiSchema.ts",
|
| 150 | "line": 2540,
|
| 151 | "character": 2
|
| 152 | }
|
| 153 | ],
|
| 154 | "type": {
|
| 155 | "type": "reference",
|
| 156 | "name": "FieldRelationships"
|
| 157 | }
|
| 158 | },
|
| 159 | {
|
| 160 | "id": 6,
|
| 161 | "name": "type",
|
| 162 | "kind": 1024,
|
| 163 | "kindString": "Property",
|
| 164 | "flags": {},
|
| 165 | "sources": [
|
| 166 | {
|
| 167 | "fileName": "SiteApiSchema.ts",
|
| 168 | "line": 2537,
|
| 169 | "character": 2
|
| 170 | }
|
| 171 | ],
|
| 172 | "type": {
|
| 173 | "type": "literal",
|
| 174 | "value": "field"
|
| 175 | }
|
| 176 | }
|
| 177 | ],
|
| 178 | "groups": [
|
| 179 | {
|
| 180 | "title": "Properties",
|
| 181 | "kind": 1024,
|
| 182 | "children": [
|
| 183 | 8,
|
| 184 | 7,
|
| 185 | 9,
|
| 186 | 6
|
| 187 | ]
|
| 188 | }
|
| 189 | ],
|
| 190 | "sources": [
|
| 191 | {
|
| 192 | "fileName": "SiteApiSchema.ts",
|
| 193 | "line": 2536,
|
| 194 | "character": 17
|
| 195 | }
|
| 196 | ]
|
| 197 | },
|
| 198 | {
|
| 199 | "id": 10,
|
| 200 | "name": "Item",
|
| 201 | "kind": 256,
|
| 202 | "kindString": "Interface",
|
| 203 | "flags": {},
|
| 204 | "comment": {
|
| 205 | "shortText": "DatoCMS stores the individual pieces of content you create from a model as records,\nwhich are much like table rows in a database. For backward-compatibility reasons, the\nAPI refers to records as \"items\".",
|
| 206 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"item\".\n"
|
| 207 | },
|
| 208 | "children": [
|
| 209 | {
|
| 210 | "id": 13,
|
| 211 | "name": "attributes",
|
| 212 | "kind": 1024,
|
| 213 | "kindString": "Property",
|
| 214 | "flags": {},
|
| 215 | "sources": [
|
| 216 | {
|
| 217 | "fileName": "SiteApiSchema.ts",
|
| 218 | "line": 3563,
|
| 219 | "character": 2
|
| 220 | }
|
| 221 | ],
|
| 222 | "type": {
|
| 223 | "type": "reference",
|
| 224 | "name": "ItemAttributes"
|
| 225 | }
|
| 226 | },
|
| 227 | {
|
| 228 | "id": 12,
|
| 229 | "name": "id",
|
| 230 | "kind": 1024,
|
| 231 | "kindString": "Property",
|
| 232 | "flags": {},
|
| 233 | "sources": [
|
| 234 | {
|
| 235 | "fileName": "SiteApiSchema.ts",
|
| 236 | "line": 3562,
|
| 237 | "character": 2
|
| 238 | }
|
| 239 | ],
|
| 240 | "type": {
|
| 241 | "type": "intrinsic",
|
| 242 | "name": "string"
|
| 243 | }
|
| 244 | },
|
| 245 | {
|
| 246 | "id": 15,
|
| 247 | "name": "meta",
|
| 248 | "kind": 1024,
|
| 249 | "kindString": "Property",
|
| 250 | "flags": {},
|
| 251 | "sources": [
|
| 252 | {
|
| 253 | "fileName": "SiteApiSchema.ts",
|
| 254 | "line": 3565,
|
| 255 | "character": 2
|
| 256 | }
|
| 257 | ],
|
| 258 | "type": {
|
| 259 | "type": "reference",
|
| 260 | "name": "ItemMeta"
|
| 261 | }
|
| 262 | },
|
| 263 | {
|
| 264 | "id": 14,
|
| 265 | "name": "relationships",
|
| 266 | "kind": 1024,
|
| 267 | "kindString": "Property",
|
| 268 | "flags": {},
|
| 269 | "sources": [
|
| 270 | {
|
| 271 | "fileName": "SiteApiSchema.ts",
|
| 272 | "line": 3564,
|
| 273 | "character": 2
|
| 274 | }
|
| 275 | ],
|
| 276 | "type": {
|
| 277 | "type": "reference",
|
| 278 | "name": "ItemRelationships"
|
| 279 | }
|
| 280 | },
|
| 281 | {
|
| 282 | "id": 11,
|
| 283 | "name": "type",
|
| 284 | "kind": 1024,
|
| 285 | "kindString": "Property",
|
| 286 | "flags": {},
|
| 287 | "sources": [
|
| 288 | {
|
| 289 | "fileName": "SiteApiSchema.ts",
|
| 290 | "line": 3561,
|
| 291 | "character": 2
|
| 292 | }
|
| 293 | ],
|
| 294 | "type": {
|
| 295 | "type": "literal",
|
| 296 | "value": "item"
|
| 297 | }
|
| 298 | }
|
| 299 | ],
|
| 300 | "groups": [
|
| 301 | {
|
| 302 | "title": "Properties",
|
| 303 | "kind": 1024,
|
| 304 | "children": [
|
| 305 | 13,
|
| 306 | 12,
|
| 307 | 15,
|
| 308 | 14,
|
| 309 | 11
|
| 310 | ]
|
| 311 | }
|
| 312 | ],
|
| 313 | "sources": [
|
| 314 | {
|
| 315 | "fileName": "SiteApiSchema.ts",
|
| 316 | "line": 3560,
|
| 317 | "character": 17
|
| 318 | }
|
| 319 | ]
|
| 320 | },
|
| 321 | {
|
| 322 | "id": 16,
|
| 323 | "name": "ModelBlock",
|
| 324 | "kind": 256,
|
| 325 | "kindString": "Interface",
|
| 326 | "flags": {},
|
| 327 | "comment": {
|
| 328 | "shortText": "The way you define the kind of content you can edit inside your administrative area\npasses through the concept of Models, which are much like database tables. For\nbackward-compatibility reasons, the API refers to models as \"item types\".",
|
| 329 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`\n\"item_type\".\n"
|
| 330 | },
|
| 331 | "children": [
|
| 332 | {
|
| 333 | "id": 19,
|
| 334 | "name": "attributes",
|
| 335 | "kind": 1024,
|
| 336 | "kindString": "Property",
|
| 337 | "flags": {},
|
| 338 | "sources": [
|
| 339 | {
|
| 340 | "fileName": "SiteApiSchema.ts",
|
| 341 | "line": 2261,
|
| 342 | "character": 2
|
| 343 | }
|
| 344 | ],
|
| 345 | "type": {
|
| 346 | "type": "reference",
|
| 347 | "name": "ItemTypeAttributes"
|
| 348 | }
|
| 349 | },
|
| 350 | {
|
| 351 | "id": 18,
|
| 352 | "name": "id",
|
| 353 | "kind": 1024,
|
| 354 | "kindString": "Property",
|
| 355 | "flags": {},
|
| 356 | "sources": [
|
| 357 | {
|
| 358 | "fileName": "SiteApiSchema.ts",
|
| 359 | "line": 2260,
|
| 360 | "character": 2
|
| 361 | }
|
| 362 | ],
|
| 363 | "type": {
|
| 364 | "type": "intrinsic",
|
| 365 | "name": "string"
|
| 366 | }
|
| 367 | },
|
| 368 | {
|
| 369 | "id": 20,
|
| 370 | "name": "relationships",
|
| 371 | "kind": 1024,
|
| 372 | "kindString": "Property",
|
| 373 | "flags": {},
|
| 374 | "sources": [
|
| 375 | {
|
| 376 | "fileName": "SiteApiSchema.ts",
|
| 377 | "line": 2262,
|
| 378 | "character": 2
|
| 379 | }
|
| 380 | ],
|
| 381 | "type": {
|
| 382 | "type": "reference",
|
| 383 | "name": "ItemTypeRelationships"
|
| 384 | }
|
| 385 | },
|
| 386 | {
|
| 387 | "id": 17,
|
| 388 | "name": "type",
|
| 389 | "kind": 1024,
|
| 390 | "kindString": "Property",
|
| 391 | "flags": {},
|
| 392 | "sources": [
|
| 393 | {
|
| 394 | "fileName": "SiteApiSchema.ts",
|
| 395 | "line": 2259,
|
| 396 | "character": 2
|
| 397 | }
|
| 398 | ],
|
| 399 | "type": {
|
| 400 | "type": "literal",
|
| 401 | "value": "item_type"
|
| 402 | }
|
| 403 | }
|
| 404 | ],
|
| 405 | "groups": [
|
| 406 | {
|
| 407 | "title": "Properties",
|
| 408 | "kind": 1024,
|
| 409 | "children": [
|
| 410 | 19,
|
| 411 | 18,
|
| 412 | 20,
|
| 413 | 17
|
| 414 | ]
|
| 415 | }
|
| 416 | ],
|
| 417 | "sources": [
|
| 418 | {
|
| 419 | "fileName": "SiteApiSchema.ts",
|
| 420 | "line": 2258,
|
| 421 | "character": 17
|
| 422 | }
|
| 423 | ]
|
| 424 | },
|
| 425 | {
|
| 426 | "id": 21,
|
| 427 | "name": "Plugin",
|
| 428 | "kind": 256,
|
| 429 | "kindString": "Interface",
|
| 430 | "flags": {},
|
| 431 | "comment": {
|
| 432 | "shortText": "Plugins enable developers to replace DatoCMS field components with HTML5 applications\nso the editing experiences of the DatoCMS web app can be customized.",
|
| 433 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"plugin\".\n"
|
| 434 | },
|
| 435 | "children": [
|
| 436 | {
|
| 437 | "id": 24,
|
| 438 | "name": "attributes",
|
| 439 | "kind": 1024,
|
| 440 | "kindString": "Property",
|
| 441 | "flags": {},
|
| 442 | "sources": [
|
| 443 | {
|
| 444 | "fileName": "SiteApiSchema.ts",
|
| 445 | "line": 3165,
|
| 446 | "character": 2
|
| 447 | }
|
| 448 | ],
|
| 449 | "type": {
|
| 450 | "type": "reference",
|
| 451 | "name": "PluginAttributes"
|
| 452 | }
|
| 453 | },
|
| 454 | {
|
| 455 | "id": 23,
|
| 456 | "name": "id",
|
| 457 | "kind": 1024,
|
| 458 | "kindString": "Property",
|
| 459 | "flags": {},
|
| 460 | "sources": [
|
| 461 | {
|
| 462 | "fileName": "SiteApiSchema.ts",
|
| 463 | "line": 3164,
|
| 464 | "character": 2
|
| 465 | }
|
| 466 | ],
|
| 467 | "type": {
|
| 468 | "type": "intrinsic",
|
| 469 | "name": "string"
|
| 470 | }
|
| 471 | },
|
| 472 | {
|
| 473 | "id": 25,
|
| 474 | "name": "meta",
|
| 475 | "kind": 1024,
|
| 476 | "kindString": "Property",
|
| 477 | "flags": {},
|
| 478 | "sources": [
|
| 479 | {
|
| 480 | "fileName": "SiteApiSchema.ts",
|
| 481 | "line": 3166,
|
| 482 | "character": 2
|
| 483 | }
|
| 484 | ],
|
| 485 | "type": {
|
| 486 | "type": "reference",
|
| 487 | "name": "PluginMeta"
|
| 488 | }
|
| 489 | },
|
| 490 | {
|
| 491 | "id": 22,
|
| 492 | "name": "type",
|
| 493 | "kind": 1024,
|
| 494 | "kindString": "Property",
|
| 495 | "flags": {},
|
| 496 | "sources": [
|
| 497 | {
|
| 498 | "fileName": "SiteApiSchema.ts",
|
| 499 | "line": 3163,
|
| 500 | "character": 2
|
| 501 | }
|
| 502 | ],
|
| 503 | "type": {
|
| 504 | "type": "literal",
|
| 505 | "value": "plugin"
|
| 506 | }
|
| 507 | }
|
| 508 | ],
|
| 509 | "groups": [
|
| 510 | {
|
| 511 | "title": "Properties",
|
| 512 | "kind": 1024,
|
| 513 | "children": [
|
| 514 | 24,
|
| 515 | 23,
|
| 516 | 25,
|
| 517 | 22
|
| 518 | ]
|
| 519 | }
|
| 520 | ],
|
| 521 | "sources": [
|
| 522 | {
|
| 523 | "fileName": "SiteApiSchema.ts",
|
| 524 | "line": 3162,
|
| 525 | "character": 17
|
| 526 | }
|
| 527 | ]
|
| 528 | },
|
| 529 | {
|
| 530 | "id": 48,
|
| 531 | "name": "Role",
|
| 532 | "kind": 256,
|
| 533 | "kindString": "Interface",
|
| 534 | "flags": {},
|
| 535 | "comment": {
|
| 536 | "shortText": "A Role represents a specific set of actions an editor (or an API token) can perform on\nyour administrative area.",
|
| 537 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"role\".\n"
|
| 538 | },
|
| 539 | "children": [
|
| 540 | {
|
| 541 | "id": 51,
|
| 542 | "name": "attributes",
|
| 543 | "kind": 1024,
|
| 544 | "kindString": "Property",
|
| 545 | "flags": {},
|
| 546 | "sources": [
|
| 547 | {
|
| 548 | "fileName": "SiteApiSchema.ts",
|
| 549 | "line": 930,
|
| 550 | "character": 2
|
| 551 | }
|
| 552 | ],
|
| 553 | "type": {
|
| 554 | "type": "reference",
|
| 555 | "name": "RoleAttributes"
|
| 556 | }
|
| 557 | },
|
| 558 | {
|
| 559 | "id": 50,
|
| 560 | "name": "id",
|
| 561 | "kind": 1024,
|
| 562 | "kindString": "Property",
|
| 563 | "flags": {},
|
| 564 | "sources": [
|
| 565 | {
|
| 566 | "fileName": "SiteApiSchema.ts",
|
| 567 | "line": 929,
|
| 568 | "character": 2
|
| 569 | }
|
| 570 | ],
|
| 571 | "type": {
|
| 572 | "type": "intrinsic",
|
| 573 | "name": "string"
|
| 574 | }
|
| 575 | },
|
| 576 | {
|
| 577 | "id": 53,
|
| 578 | "name": "meta",
|
| 579 | "kind": 1024,
|
| 580 | "kindString": "Property",
|
| 581 | "flags": {},
|
| 582 | "sources": [
|
| 583 | {
|
| 584 | "fileName": "SiteApiSchema.ts",
|
| 585 | "line": 932,
|
| 586 | "character": 2
|
| 587 | }
|
| 588 | ],
|
| 589 | "type": {
|
| 590 | "type": "reference",
|
| 591 | "name": "RoleMeta"
|
| 592 | }
|
| 593 | },
|
| 594 | {
|
| 595 | "id": 52,
|
| 596 | "name": "relationships",
|
| 597 | "kind": 1024,
|
| 598 | "kindString": "Property",
|
| 599 | "flags": {},
|
| 600 | "sources": [
|
| 601 | {
|
| 602 | "fileName": "SiteApiSchema.ts",
|
| 603 | "line": 931,
|
| 604 | "character": 2
|
| 605 | }
|
| 606 | ],
|
| 607 | "type": {
|
| 608 | "type": "reference",
|
| 609 | "name": "RoleRelationships"
|
| 610 | }
|
| 611 | },
|
| 612 | {
|
| 613 | "id": 49,
|
| 614 | "name": "type",
|
| 615 | "kind": 1024,
|
| 616 | "kindString": "Property",
|
| 617 | "flags": {},
|
| 618 | "sources": [
|
| 619 | {
|
| 620 | "fileName": "SiteApiSchema.ts",
|
| 621 | "line": 928,
|
| 622 | "character": 2
|
| 623 | }
|
| 624 | ],
|
| 625 | "type": {
|
| 626 | "type": "literal",
|
| 627 | "value": "role"
|
| 628 | }
|
| 629 | }
|
| 630 | ],
|
| 631 | "groups": [
|
| 632 | {
|
| 633 | "title": "Properties",
|
| 634 | "kind": 1024,
|
| 635 | "children": [
|
| 636 | 51,
|
| 637 | 50,
|
| 638 | 53,
|
| 639 | 52,
|
| 640 | 49
|
| 641 | ]
|
| 642 | }
|
| 643 | ],
|
| 644 | "sources": [
|
| 645 | {
|
| 646 | "fileName": "SiteApiSchema.ts",
|
| 647 | "line": 927,
|
| 648 | "character": 17
|
| 649 | }
|
| 650 | ]
|
| 651 | },
|
| 652 | {
|
| 653 | "id": 26,
|
| 654 | "name": "Site",
|
| 655 | "kind": 256,
|
| 656 | "kindString": "Interface",
|
| 657 | "flags": {},
|
| 658 | "comment": {
|
| 659 | "shortText": "A site represents a specific DatoCMS administrative area",
|
| 660 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"site\".\n"
|
| 661 | },
|
| 662 | "children": [
|
| 663 | {
|
| 664 | "id": 29,
|
| 665 | "name": "attributes",
|
| 666 | "kind": 1024,
|
| 667 | "kindString": "Property",
|
| 668 | "flags": {},
|
| 669 | "sources": [
|
| 670 | {
|
| 671 | "fileName": "SiteApiSchema.ts",
|
| 672 | "line": 6053,
|
| 673 | "character": 2
|
| 674 | }
|
| 675 | ],
|
| 676 | "type": {
|
| 677 | "type": "reference",
|
| 678 | "name": "SiteAttributes"
|
| 679 | }
|
| 680 | },
|
| 681 | {
|
| 682 | "id": 28,
|
| 683 | "name": "id",
|
| 684 | "kind": 1024,
|
| 685 | "kindString": "Property",
|
| 686 | "flags": {},
|
| 687 | "sources": [
|
| 688 | {
|
| 689 | "fileName": "SiteApiSchema.ts",
|
| 690 | "line": 6052,
|
| 691 | "character": 2
|
| 692 | }
|
| 693 | ],
|
| 694 | "type": {
|
| 695 | "type": "intrinsic",
|
| 696 | "name": "string"
|
| 697 | }
|
| 698 | },
|
| 699 | {
|
| 700 | "id": 30,
|
| 701 | "name": "relationships",
|
| 702 | "kind": 1024,
|
| 703 | "kindString": "Property",
|
| 704 | "flags": {},
|
| 705 | "sources": [
|
| 706 | {
|
| 707 | "fileName": "SiteApiSchema.ts",
|
| 708 | "line": 6054,
|
| 709 | "character": 2
|
| 710 | }
|
| 711 | ],
|
| 712 | "type": {
|
| 713 | "type": "reference",
|
| 714 | "name": "SiteRelationships"
|
| 715 | }
|
| 716 | },
|
| 717 | {
|
| 718 | "id": 27,
|
| 719 | "name": "type",
|
| 720 | "kind": 1024,
|
| 721 | "kindString": "Property",
|
| 722 | "flags": {},
|
| 723 | "sources": [
|
| 724 | {
|
| 725 | "fileName": "SiteApiSchema.ts",
|
| 726 | "line": 6051,
|
| 727 | "character": 2
|
| 728 | }
|
| 729 | ],
|
| 730 | "type": {
|
| 731 | "type": "literal",
|
| 732 | "value": "site"
|
| 733 | }
|
| 734 | }
|
| 735 | ],
|
| 736 | "groups": [
|
| 737 | {
|
| 738 | "title": "Properties",
|
| 739 | "kind": 1024,
|
| 740 | "children": [
|
| 741 | 29,
|
| 742 | 28,
|
| 743 | 30,
|
| 744 | 27
|
| 745 | ]
|
| 746 | }
|
| 747 | ],
|
| 748 | "sources": [
|
| 749 | {
|
| 750 | "fileName": "SiteApiSchema.ts",
|
| 751 | "line": 6050,
|
| 752 | "character": 17
|
| 753 | }
|
| 754 | ]
|
| 755 | },
|
| 756 | {
|
| 757 | "id": 31,
|
| 758 | "name": "SsoUser",
|
| 759 | "kind": 256,
|
| 760 | "kindString": "Interface",
|
| 761 | "flags": {},
|
| 762 | "comment": {
|
| 763 | "shortText": "A Single Sign-On user exists when a DatoCMS project is connected to an external\nIdentity Provider. An SSO user will not use the standard login procedure but has to go\nthrough SAML authentication. It can also be linked to one or more IdP groups.",
|
| 764 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"sso_user\".\n"
|
| 765 | },
|
| 766 | "children": [
|
| 767 | {
|
| 768 | "id": 34,
|
| 769 | "name": "attributes",
|
| 770 | "kind": 1024,
|
| 771 | "kindString": "Property",
|
| 772 | "flags": {},
|
| 773 | "sources": [
|
| 774 | {
|
| 775 | "fileName": "SiteApiSchema.ts",
|
| 776 | "line": 1717,
|
| 777 | "character": 2
|
| 778 | }
|
| 779 | ],
|
| 780 | "type": {
|
| 781 | "type": "reference",
|
| 782 | "name": "SsoUserAttributes"
|
| 783 | }
|
| 784 | },
|
| 785 | {
|
| 786 | "id": 33,
|
| 787 | "name": "id",
|
| 788 | "kind": 1024,
|
| 789 | "kindString": "Property",
|
| 790 | "flags": {},
|
| 791 | "sources": [
|
| 792 | {
|
| 793 | "fileName": "SiteApiSchema.ts",
|
| 794 | "line": 1716,
|
| 795 | "character": 2
|
| 796 | }
|
| 797 | ],
|
| 798 | "type": {
|
| 799 | "type": "intrinsic",
|
| 800 | "name": "string"
|
| 801 | }
|
| 802 | },
|
| 803 | {
|
| 804 | "id": 36,
|
| 805 | "name": "meta",
|
| 806 | "kind": 1024,
|
| 807 | "kindString": "Property",
|
| 808 | "flags": {},
|
| 809 | "sources": [
|
| 810 | {
|
| 811 | "fileName": "SiteApiSchema.ts",
|
| 812 | "line": 1719,
|
| 813 | "character": 2
|
| 814 | }
|
| 815 | ],
|
| 816 | "type": {
|
| 817 | "type": "reference",
|
| 818 | "name": "SsoUserMeta"
|
| 819 | }
|
| 820 | },
|
| 821 | {
|
| 822 | "id": 35,
|
| 823 | "name": "relationships",
|
| 824 | "kind": 1024,
|
| 825 | "kindString": "Property",
|
| 826 | "flags": {},
|
| 827 | "sources": [
|
| 828 | {
|
| 829 | "fileName": "SiteApiSchema.ts",
|
| 830 | "line": 1718,
|
| 831 | "character": 2
|
| 832 | }
|
| 833 | ],
|
| 834 | "type": {
|
| 835 | "type": "reference",
|
| 836 | "name": "SsoUserRelationships"
|
| 837 | }
|
| 838 | },
|
| 839 | {
|
| 840 | "id": 32,
|
| 841 | "name": "type",
|
| 842 | "kind": 1024,
|
| 843 | "kindString": "Property",
|
| 844 | "flags": {},
|
| 845 | "sources": [
|
| 846 | {
|
| 847 | "fileName": "SiteApiSchema.ts",
|
| 848 | "line": 1715,
|
| 849 | "character": 2
|
| 850 | }
|
| 851 | ],
|
| 852 | "type": {
|
| 853 | "type": "literal",
|
| 854 | "value": "sso_user"
|
| 855 | }
|
| 856 | }
|
| 857 | ],
|
| 858 | "groups": [
|
| 859 | {
|
| 860 | "title": "Properties",
|
| 861 | "kind": 1024,
|
| 862 | "children": [
|
| 863 | 34,
|
| 864 | 33,
|
| 865 | 36,
|
| 866 | 35,
|
| 867 | 32
|
| 868 | ]
|
| 869 | }
|
| 870 | ],
|
| 871 | "sources": [
|
| 872 | {
|
| 873 | "fileName": "SiteApiSchema.ts",
|
| 874 | "line": 1714,
|
| 875 | "character": 17
|
| 876 | }
|
| 877 | ]
|
| 878 | },
|
| 879 | {
|
| 880 | "id": 37,
|
| 881 | "name": "Upload",
|
| 882 | "kind": 256,
|
| 883 | "kindString": "Interface",
|
| 884 | "flags": {},
|
| 885 | "comment": {
|
| 886 | "shortText": "Every file you upload to DatoCMS will be retrievable from this endpoint.",
|
| 887 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"upload\".\n"
|
| 888 | },
|
| 889 | "children": [
|
| 890 | {
|
| 891 | "id": 40,
|
| 892 | "name": "attributes",
|
| 893 | "kind": 1024,
|
| 894 | "kindString": "Property",
|
| 895 | "flags": {},
|
| 896 | "sources": [
|
| 897 | {
|
| 898 | "fileName": "SiteApiSchema.ts",
|
| 899 | "line": 4044,
|
| 900 | "character": 2
|
| 901 | }
|
| 902 | ],
|
| 903 | "type": {
|
| 904 | "type": "reference",
|
| 905 | "name": "UploadAttributes"
|
| 906 | }
|
| 907 | },
|
| 908 | {
|
| 909 | "id": 39,
|
| 910 | "name": "id",
|
| 911 | "kind": 1024,
|
| 912 | "kindString": "Property",
|
| 913 | "flags": {},
|
| 914 | "sources": [
|
| 915 | {
|
| 916 | "fileName": "SiteApiSchema.ts",
|
| 917 | "line": 4043,
|
| 918 | "character": 2
|
| 919 | }
|
| 920 | ],
|
| 921 | "type": {
|
| 922 | "type": "intrinsic",
|
| 923 | "name": "string"
|
| 924 | }
|
| 925 | },
|
| 926 | {
|
| 927 | "id": 41,
|
| 928 | "name": "relationships",
|
| 929 | "kind": 1024,
|
| 930 | "kindString": "Property",
|
| 931 | "flags": {},
|
| 932 | "sources": [
|
| 933 | {
|
| 934 | "fileName": "SiteApiSchema.ts",
|
| 935 | "line": 4045,
|
| 936 | "character": 2
|
| 937 | }
|
| 938 | ],
|
| 939 | "type": {
|
| 940 | "type": "reference",
|
| 941 | "name": "UploadRelationships"
|
| 942 | }
|
| 943 | },
|
| 944 | {
|
| 945 | "id": 38,
|
| 946 | "name": "type",
|
| 947 | "kind": 1024,
|
| 948 | "kindString": "Property",
|
| 949 | "flags": {},
|
| 950 | "sources": [
|
| 951 | {
|
| 952 | "fileName": "SiteApiSchema.ts",
|
| 953 | "line": 4042,
|
| 954 | "character": 2
|
| 955 | }
|
| 956 | ],
|
| 957 | "type": {
|
| 958 | "type": "literal",
|
| 959 | "value": "upload"
|
| 960 | }
|
| 961 | }
|
| 962 | ],
|
| 963 | "groups": [
|
| 964 | {
|
| 965 | "title": "Properties",
|
| 966 | "kind": 1024,
|
| 967 | "children": [
|
| 968 | 40,
|
| 969 | 39,
|
| 970 | 41,
|
| 971 | 38
|
| 972 | ]
|
| 973 | }
|
| 974 | ],
|
| 975 | "sources": [
|
| 976 | {
|
| 977 | "fileName": "SiteApiSchema.ts",
|
| 978 | "line": 4041,
|
| 979 | "character": 17
|
| 980 | }
|
| 981 | ]
|
| 982 | },
|
| 983 | {
|
| 984 | "id": 42,
|
| 985 | "name": "User",
|
| 986 | "kind": 256,
|
| 987 | "kindString": "Interface",
|
| 988 | "flags": {},
|
| 989 | "comment": {
|
| 990 | "shortText": "A DatoCMS administrative area can be accessed by multiple people. Every collaborator\nis linked to a specific Role, which describes what actions it will be able to perform\nonce logged in.",
|
| 991 | "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"user\".\n"
|
| 992 | },
|
| 993 | "children": [
|
| 994 | {
|
| 995 | "id": 45,
|
| 996 | "name": "attributes",
|
| 997 | "kind": 1024,
|
| 998 | "kindString": "Property",
|
| 999 | "flags": {},
|
| 1000 | "sources": [
|
| 1001 | {
|
| 1002 | "fileName": "SiteApiSchema.ts",
|
| 1003 | "line": 1626,
|
| 1004 | "character": 2
|
| 1005 | }
|
| 1006 | ],
|
| 1007 | "type": {
|
| 1008 | "type": "reference",
|
| 1009 | "name": "UserAttributes"
|
| 1010 | }
|
| 1011 | },
|
| 1012 | {
|
| 1013 | "id": 44,
|
| 1014 | "name": "id",
|
| 1015 | "kind": 1024,
|
| 1016 | "kindString": "Property",
|
| 1017 | "flags": {},
|
| 1018 | "sources": [
|
| 1019 | {
|
| 1020 | "fileName": "SiteApiSchema.ts",
|
| 1021 | "line": 1625,
|
| 1022 | "character": 2
|
| 1023 | }
|
| 1024 | ],
|
| 1025 | "type": {
|
| 1026 | "type": "intrinsic",
|
| 1027 | "name": "string"
|
| 1028 | }
|
| 1029 | },
|
| 1030 | {
|
| 1031 | "id": 47,
|
| 1032 | "name": "meta",
|
| 1033 | "kind": 1024,
|
| 1034 | "kindString": "Property",
|
| 1035 | "flags": {
|
| 1036 | "isOptional": true
|
| 1037 | },
|
| 1038 | "sources": [
|
| 1039 | {
|
| 1040 | "fileName": "SiteApiSchema.ts",
|
| 1041 | "line": 1628,
|
| 1042 | "character": 2
|
| 1043 | }
|
| 1044 | ],
|
| 1045 | "type": {
|
| 1046 | "type": "reference",
|
| 1047 | "name": "UserMeta"
|
| 1048 | }
|
| 1049 | },
|
| 1050 | {
|
| 1051 | "id": 46,
|
| 1052 | "name": "relationships",
|
| 1053 | "kind": 1024,
|
| 1054 | "kindString": "Property",
|
| 1055 | "flags": {},
|
| 1056 | "sources": [
|
| 1057 | {
|
| 1058 | "fileName": "SiteApiSchema.ts",
|
| 1059 | "line": 1627,
|
| 1060 | "character": 2
|
| 1061 | }
|
| 1062 | ],
|
| 1063 | "type": {
|
| 1064 | "type": "reference",
|
| 1065 | "name": "UserRelationships"
|
| 1066 | }
|
| 1067 | },
|
| 1068 | {
|
| 1069 | "id": 43,
|
| 1070 | "name": "type",
|
| 1071 | "kind": 1024,
|
| 1072 | "kindString": "Property",
|
| 1073 | "flags": {},
|
| 1074 | "sources": [
|
| 1075 | {
|
| 1076 | "fileName": "SiteApiSchema.ts",
|
| 1077 | "line": 1624,
|
| 1078 | "character": 2
|
| 1079 | }
|
| 1080 | ],
|
| 1081 | "type": {
|
| 1082 | "type": "literal",
|
| 1083 | "value": "user"
|
| 1084 | }
|
| 1085 | }
|
| 1086 | ],
|
| 1087 | "groups": [
|
| 1088 | {
|
| 1089 | "title": "Properties",
|
| 1090 | "kind": 1024,
|
| 1091 | "children": [
|
| 1092 | 45,
|
| 1093 | 44,
|
| 1094 | 47,
|
| 1095 | 46,
|
| 1096 | 43
|
| 1097 | ]
|
| 1098 | }
|
| 1099 | ],
|
| 1100 | "sources": [
|
| 1101 | {
|
| 1102 | "fileName": "SiteApiSchema.ts",
|
| 1103 | "line": 1623,
|
| 1104 | "character": 17
|
| 1105 | }
|
| 1106 | ]
|
| 1107 | },
|
| 1108 | {
|
| 1109 | "id": 194,
|
| 1110 | "name": "AddonOverride",
|
| 1111 | "kind": 4194304,
|
| 1112 | "kindString": "Type alias",
|
| 1113 | "flags": {},
|
| 1114 | "comment": {
|
| 1115 | "shortText": "A field addon extension forced on a field"
|
| 1116 | },
|
| 1117 | "sources": [
|
| 1118 | {
|
| 1119 | "fileName": "types.ts",
|
| 1120 | "line": 265,
|
| 1121 | "character": 12
|
| 1122 | }
|
| 1123 | ],
|
| 1124 | "type": {
|
| 1125 | "type": "reflection",
|
| 1126 | "declaration": {
|
| 1127 | "id": 195,
|
| 1128 | "name": "__type",
|
| 1129 | "kind": 65536,
|
| 1130 | "kindString": "Type literal",
|
| 1131 | "flags": {},
|
| 1132 | "children": [
|
| 1133 | {
|
| 1134 | "id": 196,
|
| 1135 | "name": "id",
|
| 1136 | "kind": 1024,
|
| 1137 | "kindString": "Property",
|
| 1138 | "flags": {},
|
| 1139 | "comment": {
|
| 1140 | "shortText": "ID of field extension. Will be the first argument for the\n`renderFieldExtension` function"
|
| 1141 | },
|
| 1142 | "sources": [
|
| 1143 | {
|
| 1144 | "fileName": "types.ts",
|
| 1145 | "line": 270,
|
| 1146 | "character": 2
|
| 1147 | }
|
| 1148 | ],
|
| 1149 | "type": {
|
| 1150 | "type": "intrinsic",
|
| 1151 | "name": "string"
|
| 1152 | }
|
| 1153 | },
|
| 1154 | {
|
| 1155 | "id": 199,
|
| 1156 | "name": "initialHeight",
|
| 1157 | "kind": 1024,
|
| 1158 | "kindString": "Property",
|
| 1159 | "flags": {
|
| 1160 | "isOptional": true
|
| 1161 | },
|
| 1162 | "comment": {
|
| 1163 | "shortText": "The initial height to set for the iframe that will render the field extension"
|
| 1164 | },
|
| 1165 | "sources": [
|
| 1166 | {
|
| 1167 | "fileName": "types.ts",
|
| 1168 | "line": 285,
|
| 1169 | "character": 2
|
| 1170 | }
|
| 1171 | ],
|
| 1172 | "type": {
|
| 1173 | "type": "intrinsic",
|
| 1174 | "name": "number"
|
| 1175 | }
|
| 1176 | },
|
| 1177 | {
|
| 1178 | "id": 197,
|
| 1179 | "name": "parameters",
|
| 1180 | "kind": 1024,
|
| 1181 | "kindString": "Property",
|
| 1182 | "flags": {
|
| 1183 | "isOptional": true
|
| 1184 | },
|
| 1185 | "comment": {
|
| 1186 | "shortText": "An arbitrary configuration object that will be passed as the `parameters`\nproperty of the second argument of the `renderFieldExtension` function"
|
| 1187 | },
|
| 1188 | "sources": [
|
| 1189 | {
|
| 1190 | "fileName": "types.ts",
|
| 1191 | "line": 275,
|
| 1192 | "character": 2
|
| 1193 | }
|
| 1194 | ],
|
| 1195 | "type": {
|
| 1196 | "type": "reference",
|
| 1197 | "typeArguments": [
|
| 1198 | {
|
| 1199 | "type": "intrinsic",
|
| 1200 | "name": "string"
|
| 1201 | },
|
| 1202 | {
|
| 1203 | "type": "intrinsic",
|
| 1204 | "name": "unknown"
|
| 1205 | }
|
| 1206 | ],
|
| 1207 | "name": "Record"
|
| 1208 | }
|
| 1209 | },
|
| 1210 | {
|
| 1211 | "id": 198,
|
| 1212 | "name": "rank",
|
| 1213 | "kind": 1024,
|
| 1214 | "kindString": "Property",
|
| 1215 | "flags": {
|
| 1216 | "isOptional": true
|
| 1217 | },
|
| 1218 | "comment": {
|
| 1219 | "shortText": "If multiple addons are present for a field, they will be sorted by\nascending `rank`. If you want to specify an explicit value for `rank`, make\nsure to offer a way for final users to customize it inside the plugin's\nsettings form, otherwise the hardcoded value you choose might clash with\nthe one of another plugin! *"
|
| 1220 | },
|
| 1221 | "sources": [
|
| 1222 | {
|
| 1223 | "fileName": "types.ts",
|
| 1224 | "line": 283,
|
| 1225 | "character": 2
|
| 1226 | }
|
| 1227 | ],
|
| 1228 | "type": {
|
| 1229 | "type": "intrinsic",
|
| 1230 | "name": "number"
|
| 1231 | }
|
| 1232 | }
|
| 1233 | ],
|
| 1234 | "groups": [
|
| 1235 | {
|
| 1236 | "title": "Properties",
|
| 1237 | "kind": 1024,
|
| 1238 | "children": [
|
| 1239 | 196,
|
| 1240 | 199,
|
| 1241 | 197,
|
| 1242 | 198
|
| 1243 | ]
|
| 1244 | }
|
| 1245 | ],
|
| 1246 | "sources": [
|
| 1247 | {
|
| 1248 | "fileName": "types.ts",
|
| 1249 | "line": 265,
|
| 1250 | "character": 28
|
| 1251 | }
|
| 1252 | ]
|
| 1253 | }
|
| 1254 | }
|
| 1255 | },
|
| 1256 | {
|
| 1257 | "id": 252,
|
| 1258 | "name": "CommonProperties",
|
| 1259 | "kind": 4194304,
|
| 1260 | "kindString": "Type alias",
|
| 1261 | "flags": {},
|
| 1262 | "comment": {
|
| 1263 | "shortText": "Generic properties available in all the hooks"
|
| 1264 | },
|
| 1265 | "sources": [
|
| 1266 | {
|
| 1267 | "fileName": "types.ts",
|
| 1268 | "line": 400,
|
| 1269 | "character": 12
|
| 1270 | }
|
| 1271 | ],
|
| 1272 | "type": {
|
| 1273 | "type": "reflection",
|
| 1274 | "declaration": {
|
| 1275 | "id": 253,
|
| 1276 | "name": "__type",
|
| 1277 | "kind": 65536,
|
| 1278 | "kindString": "Type literal",
|
| 1279 | "flags": {},
|
| 1280 | "children": [
|
| 1281 | {
|
| 1282 | "id": 258,
|
| 1283 | "name": "currentRole",
|
| 1284 | "kind": 1024,
|
| 1285 | "kindString": "Property",
|
| 1286 | "flags": {},
|
| 1287 | "comment": {
|
| 1288 | "shortText": "The role for the current DatoCMS user"
|
| 1289 | },
|
| 1290 | "sources": [
|
| 1291 | {
|
| 1292 | "fileName": "types.ts",
|
| 1293 | "line": 413,
|
| 1294 | "character": 2
|
| 1295 | }
|
| 1296 | ],
|
| 1297 | "type": {
|
| 1298 | "type": "reference",
|
| 1299 | "id": 48,
|
| 1300 | "name": "Role"
|
| 1301 | }
|
| 1302 | },
|
| 1303 | {
|
| 1304 | "id": 257,
|
| 1305 | "name": "currentUser",
|
| 1306 | "kind": 1024,
|
| 1307 | "kindString": "Property",
|
| 1308 | "flags": {},
|
| 1309 | "comment": {
|
| 1310 | "shortText": "The current DatoCMS user. It can either be the owner or one of the\ncollaborators (regular or SSO)."
|
| 1311 | },
|
| 1312 | "sources": [
|
| 1313 | {
|
| 1314 | "fileName": "types.ts",
|
| 1315 | "line": 411,
|
| 1316 | "character": 2
|
| 1317 | }
|
| 1318 | ],
|
| 1319 | "type": {
|
| 1320 | "type": "union",
|
| 1321 | "types": [
|
| 1322 | {
|
| 1323 | "type": "reference",
|
| 1324 | "id": 42,
|
| 1325 | "name": "User"
|
| 1326 | },
|
| 1327 | {
|
| 1328 | "type": "reference",
|
| 1329 | "id": 31,
|
| 1330 | "name": "SsoUser"
|
| 1331 | },
|
| 1332 | {
|
| 1333 | "type": "reference",
|
| 1334 | "id": 1,
|
| 1335 | "name": "Account"
|
| 1336 | }
|
| 1337 | ]
|
| 1338 | }
|
| 1339 | },
|
| 1340 | {
|
| 1341 | "id": 259,
|
| 1342 | "name": "currentUserAccessToken",
|
| 1343 | "kind": 1024,
|
| 1344 | "kindString": "Property",
|
| 1345 | "flags": {},
|
| 1346 | "comment": {
|
| 1347 | "shortText": "The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted"
|
| 1348 | },
|
| 1349 | "sources": [
|
| 1350 | {
|
| 1351 | "fileName": "types.ts",
|
| 1352 | "line": 418,
|
| 1353 | "character": 2
|
| 1354 | }
|
| 1355 | ],
|
| 1356 | "type": {
|
| 1357 | "type": "union",
|
| 1358 | "types": [
|
| 1359 | {
|
| 1360 | "type": "intrinsic",
|
| 1361 | "name": "string"
|
| 1362 | },
|
| 1363 | {
|
| 1364 | "type": "intrinsic",
|
| 1365 | "name": "undefined"
|
| 1366 | }
|
| 1367 | ]
|
| 1368 | }
|
| 1369 | },
|
| 1370 | {
|
| 1371 | "id": 255,
|
| 1372 | "name": "environment",
|
| 1373 | "kind": 1024,
|
| 1374 | "kindString": "Property",
|
| 1375 | "flags": {},
|
| 1376 | "comment": {
|
| 1377 | "shortText": "The ID of the current environment"
|
| 1378 | },
|
| 1379 | "sources": [
|
| 1380 | {
|
| 1381 | "fileName": "types.ts",
|
| 1382 | "line": 404,
|
| 1383 | "character": 2
|
| 1384 | }
|
| 1385 | ],
|
| 1386 | "type": {
|
| 1387 | "type": "intrinsic",
|
| 1388 | "name": "string"
|
| 1389 | }
|
| 1390 | },
|
| 1391 | {
|
| 1392 | "id": 256,
|
| 1393 | "name": "itemTypes",
|
| 1394 | "kind": 1024,
|
| 1395 | "kindString": "Property",
|
| 1396 | "flags": {},
|
| 1397 | "comment": {
|
| 1398 | "shortText": "All the models of the current DatoCMS project, indexed by ID"
|
| 1399 | },
|
| 1400 | "sources": [
|
| 1401 | {
|
| 1402 | "fileName": "types.ts",
|
| 1403 | "line": 406,
|
| 1404 | "character": 2
|
| 1405 | }
|
| 1406 | ],
|
| 1407 | "type": {
|
| 1408 | "type": "reference",
|
| 1409 | "typeArguments": [
|
| 1410 | {
|
| 1411 | "type": "reference",
|
| 1412 | "typeArguments": [
|
| 1413 | {
|
| 1414 | "type": "intrinsic",
|
| 1415 | "name": "string"
|
| 1416 | },
|
| 1417 | {
|
| 1418 | "type": "reference",
|
| 1419 | "id": 16,
|
| 1420 | "name": "ModelBlock"
|
| 1421 | }
|
| 1422 | ],
|
| 1423 | "name": "Record"
|
| 1424 | }
|
| 1425 | ],
|
| 1426 | "name": "Partial"
|
| 1427 | }
|
| 1428 | },
|
| 1429 | {
|
| 1430 | "id": 260,
|
| 1431 | "name": "plugin",
|
| 1432 | "kind": 1024,
|
| 1433 | "kindString": "Property",
|
| 1434 | "flags": {},
|
| 1435 | "comment": {
|
| 1436 | "shortText": "The current plugin"
|
| 1437 | },
|
| 1438 | "sources": [
|
| 1439 | {
|
| 1440 | "fileName": "types.ts",
|
| 1441 | "line": 420,
|
| 1442 | "character": 2
|
| 1443 | }
|
| 1444 | ],
|
| 1445 | "type": {
|
| 1446 | "type": "reference",
|
| 1447 | "id": 21,
|
| 1448 | "name": "Plugin"
|
| 1449 | }
|
| 1450 | },
|
| 1451 | {
|
| 1452 | "id": 254,
|
| 1453 | "name": "site",
|
| 1454 | "kind": 1024,
|
| 1455 | "kindString": "Property",
|
| 1456 | "flags": {},
|
| 1457 | "comment": {
|
| 1458 | "shortText": "The current DatoCMS project"
|
| 1459 | },
|
| 1460 | "sources": [
|
| 1461 | {
|
| 1462 | "fileName": "types.ts",
|
| 1463 | "line": 402,
|
| 1464 | "character": 2
|
| 1465 | }
|
| 1466 | ],
|
| 1467 | "type": {
|
| 1468 | "type": "reference",
|
| 1469 | "id": 26,
|
| 1470 | "name": "Site"
|
| 1471 | }
|
| 1472 | },
|
| 1473 | {
|
| 1474 | "id": 261,
|
| 1475 | "name": "ui",
|
| 1476 | "kind": 1024,
|
| 1477 | "kindString": "Property",
|
| 1478 | "flags": {},
|
| 1479 | "comment": {
|
| 1480 | "shortText": "UI preferences of the current user (right now, only the preferred locale is\navailable)"
|
| 1481 | },
|
| 1482 | "sources": [
|
| 1483 | {
|
| 1484 | "fileName": "types.ts",
|
| 1485 | "line": 425,
|
| 1486 | "character": 2
|
| 1487 | }
|
| 1488 | ],
|
| 1489 | "type": {
|
| 1490 | "type": "reflection",
|
| 1491 | "declaration": {
|
| 1492 | "id": 262,
|
| 1493 | "name": "__type",
|
| 1494 | "kind": 65536,
|
| 1495 | "kindString": "Type literal",
|
| 1496 | "flags": {},
|
| 1497 | "children": [
|
| 1498 | {
|
| 1499 | "id": 263,
|
| 1500 | "name": "locale",
|
| 1501 | "kind": 1024,
|
| 1502 | "kindString": "Property",
|
| 1503 | "flags": {},
|
| 1504 | "comment": {
|
| 1505 | "shortText": "Preferred locale"
|
| 1506 | },
|
| 1507 | "sources": [
|
| 1508 | {
|
| 1509 | "fileName": "types.ts",
|
| 1510 | "line": 427,
|
| 1511 | "character": 4
|
| 1512 | }
|
| 1513 | ],
|
| 1514 | "type": {
|
| 1515 | "type": "intrinsic",
|
| 1516 | "name": "string"
|
| 1517 | }
|
| 1518 | }
|
| 1519 | ],
|
| 1520 | "groups": [
|
| 1521 | {
|
| 1522 | "title": "Properties",
|
| 1523 | "kind": 1024,
|
| 1524 | "children": [
|
| 1525 | 263
|
| 1526 | ]
|
| 1527 | }
|
| 1528 | ],
|
| 1529 | "sources": [
|
| 1530 | {
|
| 1531 | "fileName": "types.ts",
|
| 1532 | "line": 425,
|
| 1533 | "character": 6
|
| 1534 | }
|
| 1535 | ]
|
| 1536 | }
|
| 1537 | }
|
| 1538 | }
|
| 1539 | ],
|
| 1540 | "groups": [
|
| 1541 | {
|
| 1542 | "title": "Properties",
|
| 1543 | "kind": 1024,
|
| 1544 | "children": [
|
| 1545 | 258,
|
| 1546 | 257,
|
| 1547 | 259,
|
| 1548 | 255,
|
| 1549 | 256,
|
| 1550 | 260,
|
| 1551 | 254,
|
| 1552 | 261
|
| 1553 | ]
|
| 1554 | }
|
| 1555 | ],
|
| 1556 | "sources": [
|
| 1557 | {
|
| 1558 | "fileName": "types.ts",
|
| 1559 | "line": 400,
|
| 1560 | "character": 31
|
| 1561 | }
|
| 1562 | ]
|
| 1563 | }
|
| 1564 | }
|
| 1565 | },
|
| 1566 | {
|
| 1567 | "id": 241,
|
| 1568 | "name": "ConfirmChoice",
|
| 1569 | "kind": 4194304,
|
| 1570 | "kindString": "Type alias",
|
| 1571 | "flags": {},
|
| 1572 | "comment": {
|
| 1573 | "shortText": "A choice presented in a `openConfirm` panel"
|
| 1574 | },
|
| 1575 | "sources": [
|
| 1576 | {
|
| 1577 | "fileName": "types.ts",
|
| 1578 | "line": 375,
|
| 1579 | "character": 12
|
| 1580 | }
|
| 1581 | ],
|
| 1582 | "type": {
|
| 1583 | "type": "reflection",
|
| 1584 | "declaration": {
|
| 1585 | "id": 242,
|
| 1586 | "name": "__type",
|
| 1587 | "kind": 65536,
|
| 1588 | "kindString": "Type literal",
|
| 1589 | "flags": {},
|
| 1590 | "children": [
|
| 1591 | {
|
| 1592 | "id": 245,
|
| 1593 | "name": "intent",
|
| 1594 | "kind": 1024,
|
| 1595 | "kindString": "Property",
|
| 1596 | "flags": {
|
| 1597 | "isOptional": true
|
| 1598 | },
|
| 1599 | "comment": {
|
| 1600 | "shortText": "The intent of the button. Will present the button in a different color accent."
|
| 1601 | },
|
| 1602 | "sources": [
|
| 1603 | {
|
| 1604 | "fileName": "types.ts",
|
| 1605 | "line": 384,
|
| 1606 | "character": 2
|
| 1607 | }
|
| 1608 | ],
|
| 1609 | "type": {
|
| 1610 | "type": "union",
|
| 1611 | "types": [
|
| 1612 | {
|
| 1613 | "type": "literal",
|
| 1614 | "value": "positive"
|
| 1615 | },
|
| 1616 | {
|
| 1617 | "type": "literal",
|
| 1618 | "value": "negative"
|
| 1619 | }
|
| 1620 | ]
|
| 1621 | }
|
| 1622 | },
|
| 1623 | {
|
| 1624 | "id": 243,
|
| 1625 | "name": "label",
|
| 1626 | "kind": 1024,
|
| 1627 | "kindString": "Property",
|
| 1628 | "flags": {},
|
| 1629 | "comment": {
|
| 1630 | "shortText": "The label to be shown for the choice"
|
| 1631 | },
|
| 1632 | "sources": [
|
| 1633 | {
|
| 1634 | "fileName": "types.ts",
|
| 1635 | "line": 377,
|
| 1636 | "character": 2
|
| 1637 | }
|
| 1638 | ],
|
| 1639 | "type": {
|
| 1640 | "type": "intrinsic",
|
| 1641 | "name": "string"
|
| 1642 | }
|
| 1643 | },
|
| 1644 | {
|
| 1645 | "id": 244,
|
| 1646 | "name": "value",
|
| 1647 | "kind": 1024,
|
| 1648 | "kindString": "Property",
|
| 1649 | "flags": {},
|
| 1650 | "comment": {
|
| 1651 | "shortText": "The value to be returned by the `openConfirm` promise if the button is\nclicked by the user"
|
| 1652 | },
|
| 1653 | "sources": [
|
| 1654 | {
|
| 1655 | "fileName": "types.ts",
|
| 1656 | "line": 382,
|
| 1657 | "character": 2
|
| 1658 | }
|
| 1659 | ],
|
| 1660 | "type": {
|
| 1661 | "type": "intrinsic",
|
| 1662 | "name": "unknown"
|
| 1663 | }
|
| 1664 | }
|
| 1665 | ],
|
| 1666 | "groups": [
|
| 1667 | {
|
| 1668 | "title": "Properties",
|
| 1669 | "kind": 1024,
|
| 1670 | "children": [
|
| 1671 | 245,
|
| 1672 | 243,
|
| 1673 | 244
|
| 1674 | ]
|
| 1675 | }
|
| 1676 | ],
|
| 1677 | "sources": [
|
| 1678 | {
|
| 1679 | "fileName": "types.ts",
|
| 1680 | "line": 375,
|
| 1681 | "character": 28
|
| 1682 | }
|
| 1683 | ]
|
| 1684 | }
|
| 1685 | }
|
| 1686 | },
|
| 1687 | {
|
| 1688 | "id": 246,
|
| 1689 | "name": "ConfirmOptions",
|
| 1690 | "kind": 4194304,
|
| 1691 | "kindString": "Type alias",
|
| 1692 | "flags": {},
|
| 1693 | "comment": {
|
| 1694 | "shortText": "Options for the `openConfirm` function"
|
| 1695 | },
|
| 1696 | "sources": [
|
| 1697 | {
|
| 1698 | "fileName": "types.ts",
|
| 1699 | "line": 388,
|
| 1700 | "character": 12
|
| 1701 | }
|
| 1702 | ],
|
| 1703 | "type": {
|
| 1704 | "type": "reflection",
|
| 1705 | "declaration": {
|
| 1706 | "id": 247,
|
| 1707 | "name": "__type",
|
| 1708 | "kind": 65536,
|
| 1709 | "kindString": "Type literal",
|
| 1710 | "flags": {},
|
| 1711 | "children": [
|
| 1712 | {
|
| 1713 | "id": 251,
|
| 1714 | "name": "cancel",
|
| 1715 | "kind": 1024,
|
| 1716 | "kindString": "Property",
|
| 1717 | "flags": {},
|
| 1718 | "comment": {
|
| 1719 | "shortText": "The cancel option to present to the user"
|
| 1720 | },
|
| 1721 | "sources": [
|
| 1722 | {
|
| 1723 | "fileName": "types.ts",
|
| 1724 | "line": 396,
|
| 1725 | "character": 2
|
| 1726 | }
|
| 1727 | ],
|
| 1728 | "type": {
|
| 1729 | "type": "reference",
|
| 1730 | "id": 241,
|
| 1731 | "name": "ConfirmChoice"
|
| 1732 | }
|
| 1733 | },
|
| 1734 | {
|
| 1735 | "id": 250,
|
| 1736 | "name": "choices",
|
| 1737 | "kind": 1024,
|
| 1738 | "kindString": "Property",
|
| 1739 | "flags": {},
|
| 1740 | "comment": {
|
| 1741 | "shortText": "The different options the user can choose from"
|
| 1742 | },
|
| 1743 | "sources": [
|
| 1744 | {
|
| 1745 | "fileName": "types.ts",
|
| 1746 | "line": 394,
|
| 1747 | "character": 2
|
| 1748 | }
|
| 1749 | ],
|
| 1750 | "type": {
|
| 1751 | "type": "array",
|
| 1752 | "elementType": {
|
| 1753 | "type": "reference",
|
| 1754 | "id": 241,
|
| 1755 | "name": "ConfirmChoice"
|
| 1756 | }
|
| 1757 | }
|
| 1758 | },
|
| 1759 | {
|
| 1760 | "id": 249,
|
| 1761 | "name": "content",
|
| 1762 | "kind": 1024,
|
| 1763 | "kindString": "Property",
|
| 1764 | "flags": {},
|
| 1765 | "comment": {
|
| 1766 | "shortText": "The main message to be shown inside the confirmation panel"
|
| 1767 | },
|
| 1768 | "sources": [
|
| 1769 | {
|
| 1770 | "fileName": "types.ts",
|
| 1771 | "line": 392,
|
| 1772 | "character": 2
|
| 1773 | }
|
| 1774 | ],
|
| 1775 | "type": {
|
| 1776 | "type": "intrinsic",
|
| 1777 | "name": "string"
|
| 1778 | }
|
| 1779 | },
|
| 1780 | {
|
| 1781 | "id": 248,
|
| 1782 | "name": "title",
|
| 1783 | "kind": 1024,
|
| 1784 | "kindString": "Property",
|
| 1785 | "flags": {},
|
| 1786 | "comment": {
|
| 1787 | "shortText": "The title to be shown inside the confirmation panel"
|
| 1788 | },
|
| 1789 | "sources": [
|
| 1790 | {
|
| 1791 | "fileName": "types.ts",
|
| 1792 | "line": 390,
|
| 1793 | "character": 2
|
| 1794 | }
|
| 1795 | ],
|
| 1796 | "type": {
|
| 1797 | "type": "intrinsic",
|
| 1798 | "name": "string"
|
| 1799 | }
|
| 1800 | }
|
| 1801 | ],
|
| 1802 | "groups": [
|
| 1803 | {
|
| 1804 | "title": "Properties",
|
| 1805 | "kind": 1024,
|
| 1806 | "children": [
|
| 1807 | 251,
|
| 1808 | 250,
|
| 1809 | 249,
|
| 1810 | 248
|
| 1811 | ]
|
| 1812 | }
|
| 1813 | ],
|
| 1814 | "sources": [
|
| 1815 | {
|
| 1816 | "fileName": "types.ts",
|
| 1817 | "line": 388,
|
| 1818 | "character": 29
|
| 1819 | }
|
| 1820 | ]
|
| 1821 | }
|
| 1822 | }
|
| 1823 | },
|
| 1824 | {
|
| 1825 | "id": 151,
|
| 1826 | "name": "ContentAreaSidebarItem",
|
| 1827 | "kind": 4194304,
|
| 1828 | "kindString": "Type alias",
|
| 1829 | "flags": {},
|
| 1830 | "comment": {
|
| 1831 | "shortText": "The sidebar in the Content Area presents a number of user-defined menu-items.\nThis object represents a new item to be added in the sidebar."
|
| 1832 | },
|
| 1833 | "sources": [
|
| 1834 | {
|
| 1835 | "fileName": "types.ts",
|
| 1836 | "line": 127,
|
| 1837 | "character": 12
|
| 1838 | }
|
| 1839 | ],
|
| 1840 | "type": {
|
| 1841 | "type": "reflection",
|
| 1842 | "declaration": {
|
| 1843 | "id": 152,
|
| 1844 | "name": "__type",
|
| 1845 | "kind": 65536,
|
| 1846 | "kindString": "Type literal",
|
| 1847 | "flags": {},
|
| 1848 | "children": [
|
| 1849 | {
|
| 1850 | "id": 154,
|
| 1851 | "name": "icon",
|
| 1852 | "kind": 1024,
|
| 1853 | "kindString": "Property",
|
| 1854 | "flags": {},
|
| 1855 | "comment": {
|
| 1856 | "shortText": "FontAwesome icon name to be shown alongside the label"
|
| 1857 | },
|
| 1858 | "sources": [
|
| 1859 | {
|
| 1860 | "fileName": "types.ts",
|
| 1861 | "line": 131,
|
| 1862 | "character": 2
|
| 1863 | }
|
| 1864 | ],
|
| 1865 | "type": {
|
| 1866 | "type": "intrinsic",
|
| 1867 | "name": "string"
|
| 1868 | }
|
| 1869 | },
|
| 1870 | {
|
| 1871 | "id": 153,
|
| 1872 | "name": "label",
|
| 1873 | "kind": 1024,
|
| 1874 | "kindString": "Property",
|
| 1875 | "flags": {},
|
| 1876 | "comment": {
|
| 1877 | "shortText": "Label to be shown. Must be unique."
|
| 1878 | },
|
| 1879 | "sources": [
|
| 1880 | {
|
| 1881 | "fileName": "types.ts",
|
| 1882 | "line": 129,
|
| 1883 | "character": 2
|
| 1884 | }
|
| 1885 | ],
|
| 1886 | "type": {
|
| 1887 | "type": "intrinsic",
|
| 1888 | "name": "string"
|
| 1889 | }
|
| 1890 | },
|
| 1891 | {
|
| 1892 | "id": 158,
|
| 1893 | "name": "placement",
|
| 1894 | "kind": 1024,
|
| 1895 | "kindString": "Property",
|
| 1896 | "flags": {
|
| 1897 | "isOptional": true
|
| 1898 | },
|
| 1899 | "comment": {
|
| 1900 | "shortText": "Expresses where you want the item to be placed inside the sidebar. If not\nspecified, the item will be placed after the standard items provided by\nDatoCMS itself."
|
| 1901 | },
|
| 1902 | "sources": [
|
| 1903 | {
|
| 1904 | "fileName": "types.ts",
|
| 1905 | "line": 141,
|
| 1906 | "character": 2
|
| 1907 | }
|
| 1908 | ],
|
| 1909 | "type": {
|
| 1910 | "type": "tuple",
|
| 1911 | "elements": [
|
| 1912 | {
|
| 1913 | "type": "union",
|
| 1914 | "types": [
|
| 1915 | {
|
| 1916 | "type": "literal",
|
| 1917 | "value": "before"
|
| 1918 | },
|
| 1919 | {
|
| 1920 | "type": "literal",
|
| 1921 | "value": "after"
|
| 1922 | }
|
| 1923 | ]
|
| 1924 | },
|
| 1925 | {
|
| 1926 | "type": "union",
|
| 1927 | "types": [
|
| 1928 | {
|
| 1929 | "type": "literal",
|
| 1930 | "value": "menuItems"
|
| 1931 | },
|
| 1932 | {
|
| 1933 | "type": "literal",
|
| 1934 | "value": "settings"
|
| 1935 | }
|
| 1936 | ]
|
| 1937 | }
|
| 1938 | ]
|
| 1939 | }
|
| 1940 | },
|
| 1941 | {
|
| 1942 | "id": 155,
|
| 1943 | "name": "pointsTo",
|
| 1944 | "kind": 1024,
|
| 1945 | "kindString": "Property",
|
| 1946 | "flags": {},
|
| 1947 | "comment": {
|
| 1948 | "shortText": "ID of the page linked to the item"
|
| 1949 | },
|
| 1950 | "sources": [
|
| 1951 | {
|
| 1952 | "fileName": "types.ts",
|
| 1953 | "line": 133,
|
| 1954 | "character": 2
|
| 1955 | }
|
| 1956 | ],
|
| 1957 | "type": {
|
| 1958 | "type": "reflection",
|
| 1959 | "declaration": {
|
| 1960 | "id": 156,
|
| 1961 | "name": "__type",
|
| 1962 | "kind": 65536,
|
| 1963 | "kindString": "Type literal",
|
| 1964 | "flags": {},
|
| 1965 | "children": [
|
| 1966 | {
|
| 1967 | "id": 157,
|
| 1968 | "name": "pageId",
|
| 1969 | "kind": 1024,
|
| 1970 | "kindString": "Property",
|
| 1971 | "flags": {},
|
| 1972 | "sources": [
|
| 1973 | {
|
| 1974 | "fileName": "types.ts",
|
| 1975 | "line": 134,
|
| 1976 | "character": 4
|
| 1977 | }
|
| 1978 | ],
|
| 1979 | "type": {
|
| 1980 | "type": "intrinsic",
|
| 1981 | "name": "string"
|
| 1982 | }
|
| 1983 | }
|
| 1984 | ],
|
| 1985 | "groups": [
|
| 1986 | {
|
| 1987 | "title": "Properties",
|
| 1988 | "kind": 1024,
|
| 1989 | "children": [
|
| 1990 | 157
|
| 1991 | ]
|
| 1992 | }
|
| 1993 | ],
|
| 1994 | "sources": [
|
| 1995 | {
|
| 1996 | "fileName": "types.ts",
|
| 1997 | "line": 133,
|
| 1998 | "character": 12
|
| 1999 | }
|
| 2000 | ]
|
| 2001 | }
|
| 2002 | }
|
| 2003 | },
|
| 2004 | {
|
| 2005 | "id": 159,
|
| 2006 | "name": "rank",
|
| 2007 | "kind": 1024,
|
| 2008 | "kindString": "Property",
|
| 2009 | "flags": {
|
| 2010 | "isOptional": true
|
| 2011 | },
|
| 2012 | "comment": {
|
| 2013 | "shortText": "If different plugins specify the same `placement` for their panels, they\nwill be displayed by ascending `rank`. If you want to specify an explicit\nvalue for `rank`, make sure to offer a way for final users to customize it\ninside the plugin's settings form, otherwise the hardcoded value you choose\nmight clash with the one of another plugin! *"
|
| 2014 | },
|
| 2015 | "sources": [
|
| 2016 | {
|
| 2017 | "fileName": "types.ts",
|
| 2018 | "line": 149,
|
| 2019 | "character": 2
|
| 2020 | }
|
| 2021 | ],
|
| 2022 | "type": {
|
| 2023 | "type": "intrinsic",
|
| 2024 | "name": "number"
|
| 2025 | }
|
| 2026 | }
|
| 2027 | ],
|
| 2028 | "groups": [
|
| 2029 | {
|
| 2030 | "title": "Properties",
|
| 2031 | "kind": 1024,
|
| 2032 | "children": [
|
| 2033 | 154,
|
| 2034 | 153,
|
| 2035 | 158,
|
| 2036 | 155,
|
| 2037 | 159
|
| 2038 | ]
|
| 2039 | }
|
| 2040 | ],
|
| 2041 | "sources": [
|
| 2042 | {
|
| 2043 | "fileName": "types.ts",
|
| 2044 | "line": 127,
|
| 2045 | "character": 37
|
| 2046 | }
|
| 2047 | ]
|
| 2048 | }
|
| 2049 | }
|
| 2050 | },
|
| 2051 | {
|
| 2052 | "id": 379,
|
| 2053 | "name": "CustomDialogMethods",
|
| 2054 | "kind": 4194304,
|
| 2055 | "kindString": "Type alias",
|
| 2056 | "flags": {},
|
| 2057 | "comment": {
|
| 2058 | "shortText": "These methods can be used to open custom dialogs/confirmation panels"
|
| 2059 | },
|
| 2060 | "sources": [
|
| 2061 | {
|
| 2062 | "fileName": "types.ts",
|
| 2063 | "line": 864,
|
| 2064 | "character": 12
|
| 2065 | }
|
| 2066 | ],
|
| 2067 | "type": {
|
| 2068 | "type": "reflection",
|
| 2069 | "declaration": {
|
| 2070 | "id": 380,
|
| 2071 | "name": "__type",
|
| 2072 | "kind": 65536,
|
| 2073 | "kindString": "Type literal",
|
| 2074 | "flags": {},
|
| 2075 | "children": [
|
| 2076 | {
|
| 2077 | "id": 384,
|
| 2078 | "name": "openConfirm",
|
| 2079 | "kind": 2048,
|
| 2080 | "kindString": "Method",
|
| 2081 | "flags": {},
|
| 2082 | "sources": [
|
| 2083 | {
|
| 2084 | "fileName": "types.ts",
|
| 2085 | "line": 923,
|
| 2086 | "character": 2
|
| 2087 | }
|
| 2088 | ],
|
| 2089 | "signatures": [
|
| 2090 | {
|
| 2091 | "id": 385,
|
| 2092 | "name": "openConfirm",
|
| 2093 | "kind": 4096,
|
| 2094 | "kindString": "Call signature",
|
| 2095 | "flags": {},
|
| 2096 | "comment": {
|
| 2097 | "shortText": "Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user",
|
| 2098 | "tags": [
|
| 2099 | {
|
| 2100 | "tag": "example",
|
| 2101 | "text": "\n\n```js\nconst result = await ctx.openConfirm({\n title: 'Custom title',\n content:\n 'Lorem Ipsum is simply dummy text of the printing and typesetting industry',\n choices: [\n {\n label: 'Positive',\n value: 'positive',\n intent: 'positive',\n },\n {\n label: 'Negative',\n value: 'negative',\n intent: 'negative',\n },\n ],\n cancel: {\n label: 'Cancel',\n value: false,\n },\n});\n\nif (result) {\n ctx.notice(`Success! ${result}`);\n} else {\n ctx.alert('Cancelled!');\n}\n```\n"
|
| 2102 | }
|
| 2103 | ]
|
| 2104 | },
|
| 2105 | "parameters": [
|
| 2106 | {
|
| 2107 | "id": 386,
|
| 2108 | "name": "options",
|
| 2109 | "kind": 32768,
|
| 2110 | "kindString": "Parameter",
|
| 2111 | "flags": {},
|
| 2112 | "type": {
|
| 2113 | "type": "reference",
|
| 2114 | "id": 246,
|
| 2115 | "name": "ConfirmOptions"
|
| 2116 | }
|
| 2117 | }
|
| 2118 | ],
|
| 2119 | "type": {
|
| 2120 | "type": "reference",
|
| 2121 | "typeArguments": [
|
| 2122 | {
|
| 2123 | "type": "intrinsic",
|
| 2124 | "name": "unknown"
|
| 2125 | }
|
| 2126 | ],
|
| 2127 | "name": "Promise"
|
| 2128 | }
|
| 2129 | }
|
| 2130 | ]
|
| 2131 | },
|
| 2132 | {
|
| 2133 | "id": 381,
|
| 2134 | "name": "openModal",
|
| 2135 | "kind": 2048,
|
| 2136 | "kindString": "Method",
|
| 2137 | "flags": {},
|
| 2138 | "sources": [
|
| 2139 | {
|
| 2140 | "fileName": "types.ts",
|
| 2141 | "line": 886,
|
| 2142 | "character": 2
|
| 2143 | }
|
| 2144 | ],
|
| 2145 | "signatures": [
|
| 2146 | {
|
| 2147 | "id": 382,
|
| 2148 | "name": "openModal",
|
| 2149 | "kind": 4096,
|
| 2150 | "kindString": "Call signature",
|
| 2151 | "flags": {},
|
| 2152 | "comment": {
|
| 2153 | "shortText": "Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function",
|
| 2154 | "tags": [
|
| 2155 | {
|
| 2156 | "tag": "example",
|
| 2157 | "text": "\n\n```js\nconst result = await ctx.openModal({\n id: 'regular',\n title: 'Custom title!',\n width: 'l',\n parameters: { foo: 'bar' },\n});\n\nif (result) {\n ctx.notice(`Success! ${JSON.stringify(result)}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 2158 | }
|
| 2159 | ]
|
| 2160 | },
|
| 2161 | "parameters": [
|
| 2162 | {
|
| 2163 | "id": 383,
|
| 2164 | "name": "modal",
|
| 2165 | "kind": 32768,
|
| 2166 | "kindString": "Parameter",
|
| 2167 | "flags": {},
|
| 2168 | "type": {
|
| 2169 | "type": "reference",
|
| 2170 | "id": 222,
|
| 2171 | "name": "Modal"
|
| 2172 | }
|
| 2173 | }
|
| 2174 | ],
|
| 2175 | "type": {
|
| 2176 | "type": "reference",
|
| 2177 | "typeArguments": [
|
| 2178 | {
|
| 2179 | "type": "intrinsic",
|
| 2180 | "name": "unknown"
|
| 2181 | }
|
| 2182 | ],
|
| 2183 | "name": "Promise"
|
| 2184 | }
|
| 2185 | }
|
| 2186 | ]
|
| 2187 | }
|
| 2188 | ],
|
| 2189 | "groups": [
|
| 2190 | {
|
| 2191 | "title": "Methods",
|
| 2192 | "kind": 2048,
|
| 2193 | "children": [
|
| 2194 | 384,
|
| 2195 | 381
|
| 2196 | ]
|
| 2197 | }
|
| 2198 | ],
|
| 2199 | "sources": [
|
| 2200 | {
|
| 2201 | "fileName": "types.ts",
|
| 2202 | "line": 864,
|
| 2203 | "character": 34
|
| 2204 | }
|
| 2205 | ]
|
| 2206 | }
|
| 2207 | }
|
| 2208 | },
|
| 2209 | {
|
| 2210 | "id": 184,
|
| 2211 | "name": "EditorOverride",
|
| 2212 | "kind": 4194304,
|
| 2213 | "kindString": "Type alias",
|
| 2214 | "flags": {},
|
| 2215 | "comment": {
|
| 2216 | "shortText": "A field editor/sidebar forced on a field"
|
| 2217 | },
|
| 2218 | "sources": [
|
| 2219 | {
|
| 2220 | "fileName": "types.ts",
|
| 2221 | "line": 237,
|
| 2222 | "character": 12
|
| 2223 | }
|
| 2224 | ],
|
| 2225 | "type": {
|
| 2226 | "type": "reflection",
|
| 2227 | "declaration": {
|
| 2228 | "id": 185,
|
| 2229 | "name": "__type",
|
| 2230 | "kind": 65536,
|
| 2231 | "kindString": "Type literal",
|
| 2232 | "flags": {},
|
| 2233 | "children": [
|
| 2234 | {
|
| 2235 | "id": 187,
|
| 2236 | "name": "asSidebarPanel",
|
| 2237 | "kind": 1024,
|
| 2238 | "kindString": "Property",
|
| 2239 | "flags": {
|
| 2240 | "isOptional": true
|
| 2241 | },
|
| 2242 | "comment": {
|
| 2243 | "shortText": "Moves the field to the sidebar of the record editing page, mimicking a sidebar panel"
|
| 2244 | },
|
| 2245 | "sources": [
|
| 2246 | {
|
| 2247 | "fileName": "types.ts",
|
| 2248 | "line": 244,
|
| 2249 | "character": 2
|
| 2250 | }
|
| 2251 | ],
|
| 2252 | "type": {
|
| 2253 | "type": "union",
|
| 2254 | "types": [
|
| 2255 | {
|
| 2256 | "type": "intrinsic",
|
| 2257 | "name": "boolean"
|
| 2258 | },
|
| 2259 | {
|
| 2260 | "type": "reflection",
|
| 2261 | "declaration": {
|
| 2262 | "id": 188,
|
| 2263 | "name": "__type",
|
| 2264 | "kind": 65536,
|
| 2265 | "kindString": "Type literal",
|
| 2266 | "flags": {},
|
| 2267 | "children": [
|
| 2268 | {
|
| 2269 | "id": 190,
|
| 2270 | "name": "placement",
|
| 2271 | "kind": 1024,
|
| 2272 | "kindString": "Property",
|
| 2273 | "flags": {
|
| 2274 | "isOptional": true
|
| 2275 | },
|
| 2276 | "sources": [
|
| 2277 | {
|
| 2278 | "fileName": "types.ts",
|
| 2279 | "line": 246,
|
| 2280 | "character": 29
|
| 2281 | }
|
| 2282 | ],
|
| 2283 | "type": {
|
| 2284 | "type": "reference",
|
| 2285 | "id": 174,
|
| 2286 | "name": "ItemFormSidebarPanelPlacement"
|
| 2287 | }
|
| 2288 | },
|
| 2289 | {
|
| 2290 | "id": 189,
|
| 2291 | "name": "startOpen",
|
| 2292 | "kind": 1024,
|
| 2293 | "kindString": "Property",
|
| 2294 | "flags": {
|
| 2295 | "isOptional": true
|
| 2296 | },
|
| 2297 | "sources": [
|
| 2298 | {
|
| 2299 | "fileName": "types.ts",
|
| 2300 | "line": 246,
|
| 2301 | "character": 8
|
| 2302 | }
|
| 2303 | ],
|
| 2304 | "type": {
|
| 2305 | "type": "intrinsic",
|
| 2306 | "name": "boolean"
|
| 2307 | }
|
| 2308 | }
|
| 2309 | ],
|
| 2310 | "groups": [
|
| 2311 | {
|
| 2312 | "title": "Properties",
|
| 2313 | "kind": 1024,
|
| 2314 | "children": [
|
| 2315 | 190,
|
| 2316 | 189
|
| 2317 | ]
|
| 2318 | }
|
| 2319 | ],
|
| 2320 | "sources": [
|
| 2321 | {
|
| 2322 | "fileName": "types.ts",
|
| 2323 | "line": 246,
|
| 2324 | "character": 6
|
| 2325 | }
|
| 2326 | ]
|
| 2327 | }
|
| 2328 | }
|
| 2329 | ]
|
| 2330 | }
|
| 2331 | },
|
| 2332 | {
|
| 2333 | "id": 186,
|
| 2334 | "name": "id",
|
| 2335 | "kind": 1024,
|
| 2336 | "kindString": "Property",
|
| 2337 | "flags": {},
|
| 2338 | "comment": {
|
| 2339 | "shortText": "ID of field extension. Will be the first argument for the\n`renderFieldExtension` function"
|
| 2340 | },
|
| 2341 | "sources": [
|
| 2342 | {
|
| 2343 | "fileName": "types.ts",
|
| 2344 | "line": 242,
|
| 2345 | "character": 2
|
| 2346 | }
|
| 2347 | ],
|
| 2348 | "type": {
|
| 2349 | "type": "intrinsic",
|
| 2350 | "name": "string"
|
| 2351 | }
|
| 2352 | },
|
| 2353 | {
|
| 2354 | "id": 193,
|
| 2355 | "name": "initialHeight",
|
| 2356 | "kind": 1024,
|
| 2357 | "kindString": "Property",
|
| 2358 | "flags": {
|
| 2359 | "isOptional": true
|
| 2360 | },
|
| 2361 | "comment": {
|
| 2362 | "shortText": "The initial height to set for the iframe that will render the field extension"
|
| 2363 | },
|
| 2364 | "sources": [
|
| 2365 | {
|
| 2366 | "fileName": "types.ts",
|
| 2367 | "line": 261,
|
| 2368 | "character": 2
|
| 2369 | }
|
| 2370 | ],
|
| 2371 | "type": {
|
| 2372 | "type": "intrinsic",
|
| 2373 | "name": "number"
|
| 2374 | }
|
| 2375 | },
|
| 2376 | {
|
| 2377 | "id": 191,
|
| 2378 | "name": "parameters",
|
| 2379 | "kind": 1024,
|
| 2380 | "kindString": "Property",
|
| 2381 | "flags": {
|
| 2382 | "isOptional": true
|
| 2383 | },
|
| 2384 | "comment": {
|
| 2385 | "shortText": "An arbitrary configuration object that will be passed as the `parameters`\nproperty of the second argument of the `renderFieldExtension` function"
|
| 2386 | },
|
| 2387 | "sources": [
|
| 2388 | {
|
| 2389 | "fileName": "types.ts",
|
| 2390 | "line": 251,
|
| 2391 | "character": 2
|
| 2392 | }
|
| 2393 | ],
|
| 2394 | "type": {
|
| 2395 | "type": "reference",
|
| 2396 | "typeArguments": [
|
| 2397 | {
|
| 2398 | "type": "intrinsic",
|
| 2399 | "name": "string"
|
| 2400 | },
|
| 2401 | {
|
| 2402 | "type": "intrinsic",
|
| 2403 | "name": "unknown"
|
| 2404 | }
|
| 2405 | ],
|
| 2406 | "name": "Record"
|
| 2407 | }
|
| 2408 | },
|
| 2409 | {
|
| 2410 | "id": 192,
|
| 2411 | "name": "rank",
|
| 2412 | "kind": 1024,
|
| 2413 | "kindString": "Property",
|
| 2414 | "flags": {
|
| 2415 | "isOptional": true
|
| 2416 | },
|
| 2417 | "comment": {
|
| 2418 | "shortText": "If multiple plugins override a field, the one with the highest `rank` will\nwin. If you want to specify an explicit value for `rank`, make sure to\noffer a way for final users to customize it inside the plugin's settings\nform, otherwise the hardcoded value you choose might clash with the one of\nanother plugin! *"
|
| 2419 | },
|
| 2420 | "sources": [
|
| 2421 | {
|
| 2422 | "fileName": "types.ts",
|
| 2423 | "line": 259,
|
| 2424 | "character": 2
|
| 2425 | }
|
| 2426 | ],
|
| 2427 | "type": {
|
| 2428 | "type": "intrinsic",
|
| 2429 | "name": "number"
|
| 2430 | }
|
| 2431 | }
|
| 2432 | ],
|
| 2433 | "groups": [
|
| 2434 | {
|
| 2435 | "title": "Properties",
|
| 2436 | "kind": 1024,
|
| 2437 | "children": [
|
| 2438 | 187,
|
| 2439 | 186,
|
| 2440 | 193,
|
| 2441 | 191,
|
| 2442 | 192
|
| 2443 | ]
|
| 2444 | }
|
| 2445 | ],
|
| 2446 | "sources": [
|
| 2447 | {
|
| 2448 | "fileName": "types.ts",
|
| 2449 | "line": 237,
|
| 2450 | "character": 29
|
| 2451 | }
|
| 2452 | ]
|
| 2453 | }
|
| 2454 | }
|
| 2455 | },
|
| 2456 | {
|
| 2457 | "id": 282,
|
| 2458 | "name": "FieldAppearanceChange",
|
| 2459 | "kind": 4194304,
|
| 2460 | "kindString": "Type alias",
|
| 2461 | "flags": {},
|
| 2462 | "sources": [
|
| 2463 | {
|
| 2464 | "fileName": "types.ts",
|
| 2465 | "line": 475,
|
| 2466 | "character": 12
|
| 2467 | }
|
| 2468 | ],
|
| 2469 | "type": {
|
| 2470 | "type": "union",
|
| 2471 | "types": [
|
| 2472 | {
|
| 2473 | "type": "reflection",
|
| 2474 | "declaration": {
|
| 2475 | "id": 283,
|
| 2476 | "name": "__type",
|
| 2477 | "kind": 65536,
|
| 2478 | "kindString": "Type literal",
|
| 2479 | "flags": {},
|
| 2480 | "children": [
|
| 2481 | {
|
| 2482 | "id": 284,
|
| 2483 | "name": "operation",
|
| 2484 | "kind": 1024,
|
| 2485 | "kindString": "Property",
|
| 2486 | "flags": {},
|
| 2487 | "sources": [
|
| 2488 | {
|
| 2489 | "fileName": "types.ts",
|
| 2490 | "line": 477,
|
| 2491 | "character": 6
|
| 2492 | }
|
| 2493 | ],
|
| 2494 | "type": {
|
| 2495 | "type": "literal",
|
| 2496 | "value": "removeEditor"
|
| 2497 | }
|
| 2498 | }
|
| 2499 | ],
|
| 2500 | "groups": [
|
| 2501 | {
|
| 2502 | "title": "Properties",
|
| 2503 | "kind": 1024,
|
| 2504 | "children": [
|
| 2505 | 284
|
| 2506 | ]
|
| 2507 | }
|
| 2508 | ],
|
| 2509 | "sources": [
|
| 2510 | {
|
| 2511 | "fileName": "types.ts",
|
| 2512 | "line": 476,
|
| 2513 | "character": 4
|
| 2514 | }
|
| 2515 | ]
|
| 2516 | }
|
| 2517 | },
|
| 2518 | {
|
| 2519 | "type": "reflection",
|
| 2520 | "declaration": {
|
| 2521 | "id": 285,
|
| 2522 | "name": "__type",
|
| 2523 | "kind": 65536,
|
| 2524 | "kindString": "Type literal",
|
| 2525 | "flags": {},
|
| 2526 | "children": [
|
| 2527 | {
|
| 2528 | "id": 287,
|
| 2529 | "name": "newFieldExtensionId",
|
| 2530 | "kind": 1024,
|
| 2531 | "kindString": "Property",
|
| 2532 | "flags": {
|
| 2533 | "isOptional": true
|
| 2534 | },
|
| 2535 | "sources": [
|
| 2536 | {
|
| 2537 | "fileName": "types.ts",
|
| 2538 | "line": 481,
|
| 2539 | "character": 6
|
| 2540 | }
|
| 2541 | ],
|
| 2542 | "type": {
|
| 2543 | "type": "intrinsic",
|
| 2544 | "name": "string"
|
| 2545 | }
|
| 2546 | },
|
| 2547 | {
|
| 2548 | "id": 288,
|
| 2549 | "name": "newParameters",
|
| 2550 | "kind": 1024,
|
| 2551 | "kindString": "Property",
|
| 2552 | "flags": {
|
| 2553 | "isOptional": true
|
| 2554 | },
|
| 2555 | "sources": [
|
| 2556 | {
|
| 2557 | "fileName": "types.ts",
|
| 2558 | "line": 482,
|
| 2559 | "character": 6
|
| 2560 | }
|
| 2561 | ],
|
| 2562 | "type": {
|
| 2563 | "type": "reference",
|
| 2564 | "typeArguments": [
|
| 2565 | {
|
| 2566 | "type": "intrinsic",
|
| 2567 | "name": "string"
|
| 2568 | },
|
| 2569 | {
|
| 2570 | "type": "intrinsic",
|
| 2571 | "name": "unknown"
|
| 2572 | }
|
| 2573 | ],
|
| 2574 | "name": "Record"
|
| 2575 | }
|
| 2576 | },
|
| 2577 | {
|
| 2578 | "id": 286,
|
| 2579 | "name": "operation",
|
| 2580 | "kind": 1024,
|
| 2581 | "kindString": "Property",
|
| 2582 | "flags": {},
|
| 2583 | "sources": [
|
| 2584 | {
|
| 2585 | "fileName": "types.ts",
|
| 2586 | "line": 480,
|
| 2587 | "character": 6
|
| 2588 | }
|
| 2589 | ],
|
| 2590 | "type": {
|
| 2591 | "type": "literal",
|
| 2592 | "value": "updateEditor"
|
| 2593 | }
|
| 2594 | }
|
| 2595 | ],
|
| 2596 | "groups": [
|
| 2597 | {
|
| 2598 | "title": "Properties",
|
| 2599 | "kind": 1024,
|
| 2600 | "children": [
|
| 2601 | 287,
|
| 2602 | 288,
|
| 2603 | 286
|
| 2604 | ]
|
| 2605 | }
|
| 2606 | ],
|
| 2607 | "sources": [
|
| 2608 | {
|
| 2609 | "fileName": "types.ts",
|
| 2610 | "line": 479,
|
| 2611 | "character": 4
|
| 2612 | }
|
| 2613 | ]
|
| 2614 | }
|
| 2615 | },
|
| 2616 | {
|
| 2617 | "type": "reflection",
|
| 2618 | "declaration": {
|
| 2619 | "id": 289,
|
| 2620 | "name": "__type",
|
| 2621 | "kind": 65536,
|
| 2622 | "kindString": "Type literal",
|
| 2623 | "flags": {},
|
| 2624 | "children": [
|
| 2625 | {
|
| 2626 | "id": 291,
|
| 2627 | "name": "fieldExtensionId",
|
| 2628 | "kind": 1024,
|
| 2629 | "kindString": "Property",
|
| 2630 | "flags": {},
|
| 2631 | "sources": [
|
| 2632 | {
|
| 2633 | "fileName": "types.ts",
|
| 2634 | "line": 486,
|
| 2635 | "character": 6
|
| 2636 | }
|
| 2637 | ],
|
| 2638 | "type": {
|
| 2639 | "type": "intrinsic",
|
| 2640 | "name": "string"
|
| 2641 | }
|
| 2642 | },
|
| 2643 | {
|
| 2644 | "id": 290,
|
| 2645 | "name": "operation",
|
| 2646 | "kind": 1024,
|
| 2647 | "kindString": "Property",
|
| 2648 | "flags": {},
|
| 2649 | "sources": [
|
| 2650 | {
|
| 2651 | "fileName": "types.ts",
|
| 2652 | "line": 485,
|
| 2653 | "character": 6
|
| 2654 | }
|
| 2655 | ],
|
| 2656 | "type": {
|
| 2657 | "type": "literal",
|
| 2658 | "value": "setEditor"
|
| 2659 | }
|
| 2660 | },
|
| 2661 | {
|
| 2662 | "id": 292,
|
| 2663 | "name": "parameters",
|
| 2664 | "kind": 1024,
|
| 2665 | "kindString": "Property",
|
| 2666 | "flags": {},
|
| 2667 | "sources": [
|
| 2668 | {
|
| 2669 | "fileName": "types.ts",
|
| 2670 | "line": 487,
|
| 2671 | "character": 6
|
| 2672 | }
|
| 2673 | ],
|
| 2674 | "type": {
|
| 2675 | "type": "reference",
|
| 2676 | "typeArguments": [
|
| 2677 | {
|
| 2678 | "type": "intrinsic",
|
| 2679 | "name": "string"
|
| 2680 | },
|
| 2681 | {
|
| 2682 | "type": "intrinsic",
|
| 2683 | "name": "unknown"
|
| 2684 | }
|
| 2685 | ],
|
| 2686 | "name": "Record"
|
| 2687 | }
|
| 2688 | }
|
| 2689 | ],
|
| 2690 | "groups": [
|
| 2691 | {
|
| 2692 | "title": "Properties",
|
| 2693 | "kind": 1024,
|
| 2694 | "children": [
|
| 2695 | 291,
|
| 2696 | 290,
|
| 2697 | 292
|
| 2698 | ]
|
| 2699 | }
|
| 2700 | ],
|
| 2701 | "sources": [
|
| 2702 | {
|
| 2703 | "fileName": "types.ts",
|
| 2704 | "line": 484,
|
| 2705 | "character": 4
|
| 2706 | }
|
| 2707 | ]
|
| 2708 | }
|
| 2709 | },
|
| 2710 | {
|
| 2711 | "type": "reflection",
|
| 2712 | "declaration": {
|
| 2713 | "id": 293,
|
| 2714 | "name": "__type",
|
| 2715 | "kind": 65536,
|
| 2716 | "kindString": "Type literal",
|
| 2717 | "flags": {},
|
| 2718 | "children": [
|
| 2719 | {
|
| 2720 | "id": 295,
|
| 2721 | "name": "index",
|
| 2722 | "kind": 1024,
|
| 2723 | "kindString": "Property",
|
| 2724 | "flags": {},
|
| 2725 | "sources": [
|
| 2726 | {
|
| 2727 | "fileName": "types.ts",
|
| 2728 | "line": 491,
|
| 2729 | "character": 6
|
| 2730 | }
|
| 2731 | ],
|
| 2732 | "type": {
|
| 2733 | "type": "intrinsic",
|
| 2734 | "name": "number"
|
| 2735 | }
|
| 2736 | },
|
| 2737 | {
|
| 2738 | "id": 294,
|
| 2739 | "name": "operation",
|
| 2740 | "kind": 1024,
|
| 2741 | "kindString": "Property",
|
| 2742 | "flags": {},
|
| 2743 | "sources": [
|
| 2744 | {
|
| 2745 | "fileName": "types.ts",
|
| 2746 | "line": 490,
|
| 2747 | "character": 6
|
| 2748 | }
|
| 2749 | ],
|
| 2750 | "type": {
|
| 2751 | "type": "literal",
|
| 2752 | "value": "removeAddon"
|
| 2753 | }
|
| 2754 | }
|
| 2755 | ],
|
| 2756 | "groups": [
|
| 2757 | {
|
| 2758 | "title": "Properties",
|
| 2759 | "kind": 1024,
|
| 2760 | "children": [
|
| 2761 | 295,
|
| 2762 | 294
|
| 2763 | ]
|
| 2764 | }
|
| 2765 | ],
|
| 2766 | "sources": [
|
| 2767 | {
|
| 2768 | "fileName": "types.ts",
|
| 2769 | "line": 489,
|
| 2770 | "character": 4
|
| 2771 | }
|
| 2772 | ]
|
| 2773 | }
|
| 2774 | },
|
| 2775 | {
|
| 2776 | "type": "reflection",
|
| 2777 | "declaration": {
|
| 2778 | "id": 296,
|
| 2779 | "name": "__type",
|
| 2780 | "kind": 65536,
|
| 2781 | "kindString": "Type literal",
|
| 2782 | "flags": {},
|
| 2783 | "children": [
|
| 2784 | {
|
| 2785 | "id": 298,
|
| 2786 | "name": "index",
|
| 2787 | "kind": 1024,
|
| 2788 | "kindString": "Property",
|
| 2789 | "flags": {},
|
| 2790 | "sources": [
|
| 2791 | {
|
| 2792 | "fileName": "types.ts",
|
| 2793 | "line": 495,
|
| 2794 | "character": 6
|
| 2795 | }
|
| 2796 | ],
|
| 2797 | "type": {
|
| 2798 | "type": "intrinsic",
|
| 2799 | "name": "number"
|
| 2800 | }
|
| 2801 | },
|
| 2802 | {
|
| 2803 | "id": 299,
|
| 2804 | "name": "newFieldExtensionId",
|
| 2805 | "kind": 1024,
|
| 2806 | "kindString": "Property",
|
| 2807 | "flags": {
|
| 2808 | "isOptional": true
|
| 2809 | },
|
| 2810 | "sources": [
|
| 2811 | {
|
| 2812 | "fileName": "types.ts",
|
| 2813 | "line": 496,
|
| 2814 | "character": 6
|
| 2815 | }
|
| 2816 | ],
|
| 2817 | "type": {
|
| 2818 | "type": "intrinsic",
|
| 2819 | "name": "string"
|
| 2820 | }
|
| 2821 | },
|
| 2822 | {
|
| 2823 | "id": 300,
|
| 2824 | "name": "newParameters",
|
| 2825 | "kind": 1024,
|
| 2826 | "kindString": "Property",
|
| 2827 | "flags": {
|
| 2828 | "isOptional": true
|
| 2829 | },
|
| 2830 | "sources": [
|
| 2831 | {
|
| 2832 | "fileName": "types.ts",
|
| 2833 | "line": 497,
|
| 2834 | "character": 6
|
| 2835 | }
|
| 2836 | ],
|
| 2837 | "type": {
|
| 2838 | "type": "reference",
|
| 2839 | "typeArguments": [
|
| 2840 | {
|
| 2841 | "type": "intrinsic",
|
| 2842 | "name": "string"
|
| 2843 | },
|
| 2844 | {
|
| 2845 | "type": "intrinsic",
|
| 2846 | "name": "unknown"
|
| 2847 | }
|
| 2848 | ],
|
| 2849 | "name": "Record"
|
| 2850 | }
|
| 2851 | },
|
| 2852 | {
|
| 2853 | "id": 297,
|
| 2854 | "name": "operation",
|
| 2855 | "kind": 1024,
|
| 2856 | "kindString": "Property",
|
| 2857 | "flags": {},
|
| 2858 | "sources": [
|
| 2859 | {
|
| 2860 | "fileName": "types.ts",
|
| 2861 | "line": 494,
|
| 2862 | "character": 6
|
| 2863 | }
|
| 2864 | ],
|
| 2865 | "type": {
|
| 2866 | "type": "literal",
|
| 2867 | "value": "updateAddon"
|
| 2868 | }
|
| 2869 | }
|
| 2870 | ],
|
| 2871 | "groups": [
|
| 2872 | {
|
| 2873 | "title": "Properties",
|
| 2874 | "kind": 1024,
|
| 2875 | "children": [
|
| 2876 | 298,
|
| 2877 | 299,
|
| 2878 | 300,
|
| 2879 | 297
|
| 2880 | ]
|
| 2881 | }
|
| 2882 | ],
|
| 2883 | "sources": [
|
| 2884 | {
|
| 2885 | "fileName": "types.ts",
|
| 2886 | "line": 493,
|
| 2887 | "character": 4
|
| 2888 | }
|
| 2889 | ]
|
| 2890 | }
|
| 2891 | },
|
| 2892 | {
|
| 2893 | "type": "reflection",
|
| 2894 | "declaration": {
|
| 2895 | "id": 301,
|
| 2896 | "name": "__type",
|
| 2897 | "kind": 65536,
|
| 2898 | "kindString": "Type literal",
|
| 2899 | "flags": {},
|
| 2900 | "children": [
|
| 2901 | {
|
| 2902 | "id": 304,
|
| 2903 | "name": "fieldExtensionId",
|
| 2904 | "kind": 1024,
|
| 2905 | "kindString": "Property",
|
| 2906 | "flags": {},
|
| 2907 | "sources": [
|
| 2908 | {
|
| 2909 | "fileName": "types.ts",
|
| 2910 | "line": 502,
|
| 2911 | "character": 6
|
| 2912 | }
|
| 2913 | ],
|
| 2914 | "type": {
|
| 2915 | "type": "intrinsic",
|
| 2916 | "name": "string"
|
| 2917 | }
|
| 2918 | },
|
| 2919 | {
|
| 2920 | "id": 303,
|
| 2921 | "name": "index",
|
| 2922 | "kind": 1024,
|
| 2923 | "kindString": "Property",
|
| 2924 | "flags": {},
|
| 2925 | "sources": [
|
| 2926 | {
|
| 2927 | "fileName": "types.ts",
|
| 2928 | "line": 501,
|
| 2929 | "character": 6
|
| 2930 | }
|
| 2931 | ],
|
| 2932 | "type": {
|
| 2933 | "type": "intrinsic",
|
| 2934 | "name": "number"
|
| 2935 | }
|
| 2936 | },
|
| 2937 | {
|
| 2938 | "id": 302,
|
| 2939 | "name": "operation",
|
| 2940 | "kind": 1024,
|
| 2941 | "kindString": "Property",
|
| 2942 | "flags": {},
|
| 2943 | "sources": [
|
| 2944 | {
|
| 2945 | "fileName": "types.ts",
|
| 2946 | "line": 500,
|
| 2947 | "character": 6
|
| 2948 | }
|
| 2949 | ],
|
| 2950 | "type": {
|
| 2951 | "type": "literal",
|
| 2952 | "value": "insertAddon"
|
| 2953 | }
|
| 2954 | },
|
| 2955 | {
|
| 2956 | "id": 305,
|
| 2957 | "name": "parameters",
|
| 2958 | "kind": 1024,
|
| 2959 | "kindString": "Property",
|
| 2960 | "flags": {},
|
| 2961 | "sources": [
|
| 2962 | {
|
| 2963 | "fileName": "types.ts",
|
| 2964 | "line": 503,
|
| 2965 | "character": 6
|
| 2966 | }
|
| 2967 | ],
|
| 2968 | "type": {
|
| 2969 | "type": "reference",
|
| 2970 | "typeArguments": [
|
| 2971 | {
|
| 2972 | "type": "intrinsic",
|
| 2973 | "name": "string"
|
| 2974 | },
|
| 2975 | {
|
| 2976 | "type": "intrinsic",
|
| 2977 | "name": "unknown"
|
| 2978 | }
|
| 2979 | ],
|
| 2980 | "name": "Record"
|
| 2981 | }
|
| 2982 | }
|
| 2983 | ],
|
| 2984 | "groups": [
|
| 2985 | {
|
| 2986 | "title": "Properties",
|
| 2987 | "kind": 1024,
|
| 2988 | "children": [
|
| 2989 | 304,
|
| 2990 | 303,
|
| 2991 | 302,
|
| 2992 | 305
|
| 2993 | ]
|
| 2994 | }
|
| 2995 | ],
|
| 2996 | "sources": [
|
| 2997 | {
|
| 2998 | "fileName": "types.ts",
|
| 2999 | "line": 499,
|
| 3000 | "character": 4
|
| 3001 | }
|
| 3002 | ]
|
| 3003 | }
|
| 3004 | }
|
| 3005 | ]
|
| 3006 | }
|
| 3007 | },
|
| 3008 | {
|
| 3009 | "id": 200,
|
| 3010 | "name": "FieldExtensionOverride",
|
| 3011 | "kind": 4194304,
|
| 3012 | "kindString": "Type alias",
|
| 3013 | "flags": {},
|
| 3014 | "comment": {
|
| 3015 | "shortText": "An object expressing some field extensions you want to force on a particular field"
|
| 3016 | },
|
| 3017 | "sources": [
|
| 3018 | {
|
| 3019 | "fileName": "types.ts",
|
| 3020 | "line": 289,
|
| 3021 | "character": 12
|
| 3022 | }
|
| 3023 | ],
|
| 3024 | "type": {
|
| 3025 | "type": "reflection",
|
| 3026 | "declaration": {
|
| 3027 | "id": 201,
|
| 3028 | "name": "__type",
|
| 3029 | "kind": 65536,
|
| 3030 | "kindString": "Type literal",
|
| 3031 | "flags": {},
|
| 3032 | "children": [
|
| 3033 | {
|
| 3034 | "id": 203,
|
| 3035 | "name": "addons",
|
| 3036 | "kind": 1024,
|
| 3037 | "kindString": "Property",
|
| 3038 | "flags": {
|
| 3039 | "isOptional": true
|
| 3040 | },
|
| 3041 | "comment": {
|
| 3042 | "shortText": "One or more field sidebar extensions to forcefully add to a field"
|
| 3043 | },
|
| 3044 | "sources": [
|
| 3045 | {
|
| 3046 | "fileName": "types.ts",
|
| 3047 | "line": 293,
|
| 3048 | "character": 2
|
| 3049 | }
|
| 3050 | ],
|
| 3051 | "type": {
|
| 3052 | "type": "array",
|
| 3053 | "elementType": {
|
| 3054 | "type": "reference",
|
| 3055 | "id": 194,
|
| 3056 | "name": "AddonOverride"
|
| 3057 | }
|
| 3058 | }
|
| 3059 | },
|
| 3060 | {
|
| 3061 | "id": 202,
|
| 3062 | "name": "editor",
|
| 3063 | "kind": 1024,
|
| 3064 | "kindString": "Property",
|
| 3065 | "flags": {
|
| 3066 | "isOptional": true
|
| 3067 | },
|
| 3068 | "comment": {
|
| 3069 | "shortText": "Force a field editor/sidebar extension on a field"
|
| 3070 | },
|
| 3071 | "sources": [
|
| 3072 | {
|
| 3073 | "fileName": "types.ts",
|
| 3074 | "line": 291,
|
| 3075 | "character": 2
|
| 3076 | }
|
| 3077 | ],
|
| 3078 | "type": {
|
| 3079 | "type": "reference",
|
| 3080 | "id": 184,
|
| 3081 | "name": "EditorOverride"
|
| 3082 | }
|
| 3083 | }
|
| 3084 | ],
|
| 3085 | "groups": [
|
| 3086 | {
|
| 3087 | "title": "Properties",
|
| 3088 | "kind": 1024,
|
| 3089 | "children": [
|
| 3090 | 203,
|
| 3091 | 202
|
| 3092 | ]
|
| 3093 | }
|
| 3094 | ],
|
| 3095 | "sources": [
|
| 3096 | {
|
| 3097 | "fileName": "types.ts",
|
| 3098 | "line": 289,
|
| 3099 | "character": 37
|
| 3100 | }
|
| 3101 | ]
|
| 3102 | }
|
| 3103 | }
|
| 3104 | },
|
| 3105 | {
|
| 3106 | "id": 160,
|
| 3107 | "name": "FieldExtensionType",
|
| 3108 | "kind": 4194304,
|
| 3109 | "kindString": "Type alias",
|
| 3110 | "flags": {},
|
| 3111 | "sources": [
|
| 3112 | {
|
| 3113 | "fileName": "types.ts",
|
| 3114 | "line": 157,
|
| 3115 | "character": 12
|
| 3116 | }
|
| 3117 | ],
|
| 3118 | "type": {
|
| 3119 | "type": "union",
|
| 3120 | "types": [
|
| 3121 | {
|
| 3122 | "type": "literal",
|
| 3123 | "value": "editor"
|
| 3124 | },
|
| 3125 | {
|
| 3126 | "type": "literal",
|
| 3127 | "value": "addon"
|
| 3128 | }
|
| 3129 | ]
|
| 3130 | }
|
| 3131 | },
|
| 3132 | {
|
| 3133 | "id": 68,
|
| 3134 | "name": "FieldIntentCtx",
|
| 3135 | "kind": 4194304,
|
| 3136 | "kindString": "Type alias",
|
| 3137 | "flags": {},
|
| 3138 | "sources": [
|
| 3139 | {
|
| 3140 | "fileName": "connect.ts",
|
| 3141 | "line": 58,
|
| 3142 | "character": 12
|
| 3143 | }
|
| 3144 | ],
|
| 3145 | "type": {
|
| 3146 | "type": "intersection",
|
| 3147 | "types": [
|
| 3148 | {
|
| 3149 | "type": "reference",
|
| 3150 | "id": 272,
|
| 3151 | "name": "InitPropertiesAndMethods"
|
| 3152 | },
|
| 3153 | {
|
| 3154 | "type": "reflection",
|
| 3155 | "declaration": {
|
| 3156 | "id": 69,
|
| 3157 | "name": "__type",
|
| 3158 | "kind": 65536,
|
| 3159 | "kindString": "Type literal",
|
| 3160 | "flags": {},
|
| 3161 | "children": [
|
| 3162 | {
|
| 3163 | "id": 70,
|
| 3164 | "name": "itemType",
|
| 3165 | "kind": 1024,
|
| 3166 | "kindString": "Property",
|
| 3167 | "flags": {},
|
| 3168 | "sources": [
|
| 3169 | {
|
| 3170 | "fileName": "connect.ts",
|
| 3171 | "line": 59,
|
| 3172 | "character": 2
|
| 3173 | }
|
| 3174 | ],
|
| 3175 | "type": {
|
| 3176 | "type": "reference",
|
| 3177 | "id": 16,
|
| 3178 | "name": "ModelBlock"
|
| 3179 | }
|
| 3180 | }
|
| 3181 | ],
|
| 3182 | "groups": [
|
| 3183 | {
|
| 3184 | "title": "Properties",
|
| 3185 | "kind": 1024,
|
| 3186 | "children": [
|
| 3187 | 70
|
| 3188 | ]
|
| 3189 | }
|
| 3190 | ],
|
| 3191 | "sources": [
|
| 3192 | {
|
| 3193 | "fileName": "connect.ts",
|
| 3194 | "line": 58,
|
| 3195 | "character": 56
|
| 3196 | }
|
| 3197 | ]
|
| 3198 | }
|
| 3199 | }
|
| 3200 | ]
|
| 3201 | }
|
| 3202 | },
|
| 3203 | {
|
| 3204 | "id": 215,
|
| 3205 | "name": "FileFieldValue",
|
| 3206 | "kind": 4194304,
|
| 3207 | "kindString": "Type alias",
|
| 3208 | "flags": {},
|
| 3209 | "comment": {
|
| 3210 | "shortText": "The structure contained in a \"single asset\" field"
|
| 3211 | },
|
| 3212 | "sources": [
|
| 3213 | {
|
| 3214 | "fileName": "types.ts",
|
| 3215 | "line": 314,
|
| 3216 | "character": 12
|
| 3217 | }
|
| 3218 | ],
|
| 3219 | "type": {
|
| 3220 | "type": "reflection",
|
| 3221 | "declaration": {
|
| 3222 | "id": 216,
|
| 3223 | "name": "__type",
|
| 3224 | "kind": 65536,
|
| 3225 | "kindString": "Type literal",
|
| 3226 | "flags": {},
|
| 3227 | "children": [
|
| 3228 | {
|
| 3229 | "id": 218,
|
| 3230 | "name": "alt",
|
| 3231 | "kind": 1024,
|
| 3232 | "kindString": "Property",
|
| 3233 | "flags": {},
|
| 3234 | "comment": {
|
| 3235 | "shortText": "Alternate text for the asset"
|
| 3236 | },
|
| 3237 | "sources": [
|
| 3238 | {
|
| 3239 | "fileName": "types.ts",
|
| 3240 | "line": 319,
|
| 3241 | "character": 2
|
| 3242 | }
|
| 3243 | ],
|
| 3244 | "type": {
|
| 3245 | "type": "union",
|
| 3246 | "types": [
|
| 3247 | {
|
| 3248 | "type": "intrinsic",
|
| 3249 | "name": "string"
|
| 3250 | },
|
| 3251 | {
|
| 3252 | "type": "literal",
|
| 3253 | "value": null
|
| 3254 | }
|
| 3255 | ]
|
| 3256 | }
|
| 3257 | },
|
| 3258 | {
|
| 3259 | "id": 221,
|
| 3260 | "name": "custom_data",
|
| 3261 | "kind": 1024,
|
| 3262 | "kindString": "Property",
|
| 3263 | "flags": {},
|
| 3264 | "comment": {
|
| 3265 | "shortText": "Object with arbitrary metadata related to the asset"
|
| 3266 | },
|
| 3267 | "sources": [
|
| 3268 | {
|
| 3269 | "fileName": "types.ts",
|
| 3270 | "line": 327,
|
| 3271 | "character": 2
|
| 3272 | }
|
| 3273 | ],
|
| 3274 | "type": {
|
| 3275 | "type": "reference",
|
| 3276 | "typeArguments": [
|
| 3277 | {
|
| 3278 | "type": "intrinsic",
|
| 3279 | "name": "string"
|
| 3280 | },
|
| 3281 | {
|
| 3282 | "type": "intrinsic",
|
| 3283 | "name": "string"
|
| 3284 | }
|
| 3285 | ],
|
| 3286 | "name": "Record"
|
| 3287 | }
|
| 3288 | },
|
| 3289 | {
|
| 3290 | "id": 220,
|
| 3291 | "name": "focal_point",
|
| 3292 | "kind": 1024,
|
| 3293 | "kindString": "Property",
|
| 3294 | "flags": {},
|
| 3295 | "comment": {
|
| 3296 | "shortText": "Focal point of an asset"
|
| 3297 | },
|
| 3298 | "sources": [
|
| 3299 | {
|
| 3300 | "fileName": "types.ts",
|
| 3301 | "line": 324,
|
| 3302 | "character": 2
|
| 3303 | }
|
| 3304 | ],
|
| 3305 | "type": {
|
| 3306 | "type": "union",
|
| 3307 | "types": [
|
| 3308 | {
|
| 3309 | "type": "reference",
|
| 3310 | "id": 211,
|
| 3311 | "name": "FocalPoint"
|
| 3312 | },
|
| 3313 | {
|
| 3314 | "type": "literal",
|
| 3315 | "value": null
|
| 3316 | }
|
| 3317 | ]
|
| 3318 | }
|
| 3319 | },
|
| 3320 | {
|
| 3321 | "id": 219,
|
| 3322 | "name": "title",
|
| 3323 | "kind": 1024,
|
| 3324 | "kindString": "Property",
|
| 3325 | "flags": {},
|
| 3326 | "comment": {
|
| 3327 | "shortText": "Title for the asset"
|
| 3328 | },
|
| 3329 | "sources": [
|
| 3330 | {
|
| 3331 | "fileName": "types.ts",
|
| 3332 | "line": 321,
|
| 3333 | "character": 2
|
| 3334 | }
|
| 3335 | ],
|
| 3336 | "type": {
|
| 3337 | "type": "union",
|
| 3338 | "types": [
|
| 3339 | {
|
| 3340 | "type": "intrinsic",
|
| 3341 | "name": "string"
|
| 3342 | },
|
| 3343 | {
|
| 3344 | "type": "literal",
|
| 3345 | "value": null
|
| 3346 | }
|
| 3347 | ]
|
| 3348 | }
|
| 3349 | },
|
| 3350 | {
|
| 3351 | "id": 217,
|
| 3352 | "name": "upload_id",
|
| 3353 | "kind": 1024,
|
| 3354 | "kindString": "Property",
|
| 3355 | "flags": {},
|
| 3356 | "comment": {
|
| 3357 | "shortText": "ID of the asset"
|
| 3358 | },
|
| 3359 | "sources": [
|
| 3360 | {
|
| 3361 | "fileName": "types.ts",
|
| 3362 | "line": 317,
|
| 3363 | "character": 2
|
| 3364 | }
|
| 3365 | ],
|
| 3366 | "type": {
|
| 3367 | "type": "intrinsic",
|
| 3368 | "name": "string"
|
| 3369 | }
|
| 3370 | }
|
| 3371 | ],
|
| 3372 | "groups": [
|
| 3373 | {
|
| 3374 | "title": "Properties",
|
| 3375 | "kind": 1024,
|
| 3376 | "children": [
|
| 3377 | 218,
|
| 3378 | 221,
|
| 3379 | 220,
|
| 3380 | 219,
|
| 3381 | 217
|
| 3382 | ]
|
| 3383 | }
|
| 3384 | ],
|
| 3385 | "sources": [
|
| 3386 | {
|
| 3387 | "fileName": "types.ts",
|
| 3388 | "line": 314,
|
| 3389 | "character": 29
|
| 3390 | }
|
| 3391 | ]
|
| 3392 | }
|
| 3393 | }
|
| 3394 | },
|
| 3395 | {
|
| 3396 | "id": 211,
|
| 3397 | "name": "FocalPoint",
|
| 3398 | "kind": 4194304,
|
| 3399 | "kindString": "Type alias",
|
| 3400 | "flags": {},
|
| 3401 | "comment": {
|
| 3402 | "shortText": "Focal point of an image asset"
|
| 3403 | },
|
| 3404 | "sources": [
|
| 3405 | {
|
| 3406 | "fileName": "types.ts",
|
| 3407 | "line": 306,
|
| 3408 | "character": 12
|
| 3409 | }
|
| 3410 | ],
|
| 3411 | "type": {
|
| 3412 | "type": "reflection",
|
| 3413 | "declaration": {
|
| 3414 | "id": 212,
|
| 3415 | "name": "__type",
|
| 3416 | "kind": 65536,
|
| 3417 | "kindString": "Type literal",
|
| 3418 | "flags": {},
|
| 3419 | "children": [
|
| 3420 | {
|
| 3421 | "id": 213,
|
| 3422 | "name": "x",
|
| 3423 | "kind": 1024,
|
| 3424 | "kindString": "Property",
|
| 3425 | "flags": {},
|
| 3426 | "comment": {
|
| 3427 | "shortText": "Horizontal position expressed as float between 0 and 1"
|
| 3428 | },
|
| 3429 | "sources": [
|
| 3430 | {
|
| 3431 | "fileName": "types.ts",
|
| 3432 | "line": 308,
|
| 3433 | "character": 2
|
| 3434 | }
|
| 3435 | ],
|
| 3436 | "type": {
|
| 3437 | "type": "intrinsic",
|
| 3438 | "name": "number"
|
| 3439 | }
|
| 3440 | },
|
| 3441 | {
|
| 3442 | "id": 214,
|
| 3443 | "name": "y",
|
| 3444 | "kind": 1024,
|
| 3445 | "kindString": "Property",
|
| 3446 | "flags": {},
|
| 3447 | "comment": {
|
| 3448 | "shortText": "Vertical position expressed as float between 0 and 1"
|
| 3449 | },
|
| 3450 | "sources": [
|
| 3451 | {
|
| 3452 | "fileName": "types.ts",
|
| 3453 | "line": 310,
|
| 3454 | "character": 2
|
| 3455 | }
|
| 3456 | ],
|
| 3457 | "type": {
|
| 3458 | "type": "intrinsic",
|
| 3459 | "name": "number"
|
| 3460 | }
|
| 3461 | }
|
| 3462 | ],
|
| 3463 | "groups": [
|
| 3464 | {
|
| 3465 | "title": "Properties",
|
| 3466 | "kind": 1024,
|
| 3467 | "children": [
|
| 3468 | 213,
|
| 3469 | 214
|
| 3470 | ]
|
| 3471 | }
|
| 3472 | ],
|
| 3473 | "sources": [
|
| 3474 | {
|
| 3475 | "fileName": "types.ts",
|
| 3476 | "line": 306,
|
| 3477 | "character": 25
|
| 3478 | }
|
| 3479 | ]
|
| 3480 | }
|
| 3481 | }
|
| 3482 | },
|
| 3483 | {
|
| 3484 | "id": 77,
|
| 3485 | "name": "FullConnectParameters",
|
| 3486 | "kind": 4194304,
|
| 3487 | "kindString": "Type alias",
|
| 3488 | "flags": {},
|
| 3489 | "comment": {
|
| 3490 | "shortText": "The full options you can pass to the `connect` function"
|
| 3491 | },
|
| 3492 | "sources": [
|
| 3493 | {
|
| 3494 | "fileName": "connect.ts",
|
| 3495 | "line": 73,
|
| 3496 | "character": 12
|
| 3497 | }
|
| 3498 | ],
|
| 3499 | "type": {
|
| 3500 | "type": "reflection",
|
| 3501 | "declaration": {
|
| 3502 | "id": 78,
|
| 3503 | "name": "__type",
|
| 3504 | "kind": 65536,
|
| 3505 | "kindString": "Type literal",
|
| 3506 | "flags": {},
|
| 3507 | "children": [
|
| 3508 | {
|
| 3509 | "id": 88,
|
| 3510 | "name": "contentAreaSidebarItems",
|
| 3511 | "kind": 2048,
|
| 3512 | "kindString": "Method",
|
| 3513 | "flags": {},
|
| 3514 | "sources": [
|
| 3515 | {
|
| 3516 | "fileName": "connect.ts",
|
| 3517 | "line": 98,
|
| 3518 | "character": 2
|
| 3519 | }
|
| 3520 | ],
|
| 3521 | "signatures": [
|
| 3522 | {
|
| 3523 | "id": 89,
|
| 3524 | "name": "contentAreaSidebarItems",
|
| 3525 | "kind": 4096,
|
| 3526 | "kindString": "Call signature",
|
| 3527 | "flags": {},
|
| 3528 | "comment": {
|
| 3529 | "shortText": "Use this function to declare new navigation items in the Content Area sidebar",
|
| 3530 | "tags": [
|
| 3531 | {
|
| 3532 | "tag": "group",
|
| 3533 | "text": "pages\n"
|
| 3534 | }
|
| 3535 | ]
|
| 3536 | },
|
| 3537 | "parameters": [
|
| 3538 | {
|
| 3539 | "id": 90,
|
| 3540 | "name": "ctx",
|
| 3541 | "kind": 32768,
|
| 3542 | "kindString": "Parameter",
|
| 3543 | "flags": {},
|
| 3544 | "type": {
|
| 3545 | "type": "reference",
|
| 3546 | "id": 272,
|
| 3547 | "name": "InitPropertiesAndMethods"
|
| 3548 | }
|
| 3549 | }
|
| 3550 | ],
|
| 3551 | "type": {
|
| 3552 | "type": "array",
|
| 3553 | "elementType": {
|
| 3554 | "type": "reference",
|
| 3555 | "id": 151,
|
| 3556 | "name": "ContentAreaSidebarItem"
|
| 3557 | }
|
| 3558 | }
|
| 3559 | }
|
| 3560 | ]
|
| 3561 | },
|
| 3562 | {
|
| 3563 | "id": 94,
|
| 3564 | "name": "itemFormSidebarPanels",
|
| 3565 | "kind": 2048,
|
| 3566 | "kindString": "Method",
|
| 3567 | "flags": {},
|
| 3568 | "sources": [
|
| 3569 | {
|
| 3570 | "fileName": "connect.ts",
|
| 3571 | "line": 112,
|
| 3572 | "character": 2
|
| 3573 | }
|
| 3574 | ],
|
| 3575 | "signatures": [
|
| 3576 | {
|
| 3577 | "id": 95,
|
| 3578 | "name": "itemFormSidebarPanels",
|
| 3579 | "kind": 4096,
|
| 3580 | "kindString": "Call signature",
|
| 3581 | "flags": {},
|
| 3582 | "comment": {
|
| 3583 | "shortText": "Use this function to declare new sidebar panels to be shown when the user edits\nrecords of a particular model",
|
| 3584 | "tags": [
|
| 3585 | {
|
| 3586 | "tag": "group",
|
| 3587 | "text": "sidebarPanels\n"
|
| 3588 | }
|
| 3589 | ]
|
| 3590 | },
|
| 3591 | "parameters": [
|
| 3592 | {
|
| 3593 | "id": 96,
|
| 3594 | "name": "itemType",
|
| 3595 | "kind": 32768,
|
| 3596 | "kindString": "Parameter",
|
| 3597 | "flags": {},
|
| 3598 | "type": {
|
| 3599 | "type": "reference",
|
| 3600 | "id": 16,
|
| 3601 | "name": "ModelBlock"
|
| 3602 | }
|
| 3603 | },
|
| 3604 | {
|
| 3605 | "id": 97,
|
| 3606 | "name": "ctx",
|
| 3607 | "kind": 32768,
|
| 3608 | "kindString": "Parameter",
|
| 3609 | "flags": {},
|
| 3610 | "type": {
|
| 3611 | "type": "reference",
|
| 3612 | "id": 272,
|
| 3613 | "name": "InitPropertiesAndMethods"
|
| 3614 | }
|
| 3615 | }
|
| 3616 | ],
|
| 3617 | "type": {
|
| 3618 | "type": "array",
|
| 3619 | "elementType": {
|
| 3620 | "type": "reference",
|
| 3621 | "id": 175,
|
| 3622 | "name": "ItemFormSidebarPanel"
|
| 3623 | }
|
| 3624 | }
|
| 3625 | }
|
| 3626 | ]
|
| 3627 | },
|
| 3628 | {
|
| 3629 | "id": 82,
|
| 3630 | "name": "mainNavigationTabs",
|
| 3631 | "kind": 2048,
|
| 3632 | "kindString": "Method",
|
| 3633 | "flags": {},
|
| 3634 | "sources": [
|
| 3635 | {
|
| 3636 | "fileName": "connect.ts",
|
| 3637 | "line": 86,
|
| 3638 | "character": 2
|
| 3639 | }
|
| 3640 | ],
|
| 3641 | "signatures": [
|
| 3642 | {
|
| 3643 | "id": 83,
|
| 3644 | "name": "mainNavigationTabs",
|
| 3645 | "kind": 4096,
|
| 3646 | "kindString": "Call signature",
|
| 3647 | "flags": {},
|
| 3648 | "comment": {
|
| 3649 | "shortText": "Use this function to declare new tabs you want to add in the top-bar of the UI",
|
| 3650 | "tags": [
|
| 3651 | {
|
| 3652 | "tag": "group",
|
| 3653 | "text": "pages\n"
|
| 3654 | }
|
| 3655 | ]
|
| 3656 | },
|
| 3657 | "parameters": [
|
| 3658 | {
|
| 3659 | "id": 84,
|
| 3660 | "name": "ctx",
|
| 3661 | "kind": 32768,
|
| 3662 | "kindString": "Parameter",
|
| 3663 | "flags": {},
|
| 3664 | "type": {
|
| 3665 | "type": "reference",
|
| 3666 | "id": 272,
|
| 3667 | "name": "InitPropertiesAndMethods"
|
| 3668 | }
|
| 3669 | }
|
| 3670 | ],
|
| 3671 | "type": {
|
| 3672 | "type": "array",
|
| 3673 | "elementType": {
|
| 3674 | "type": "reference",
|
| 3675 | "id": 129,
|
| 3676 | "name": "MainNavigationTab"
|
| 3677 | }
|
| 3678 | }
|
| 3679 | }
|
| 3680 | ]
|
| 3681 | },
|
| 3682 | {
|
| 3683 | "id": 91,
|
| 3684 | "name": "manualFieldExtensions",
|
| 3685 | "kind": 2048,
|
| 3686 | "kindString": "Method",
|
| 3687 | "flags": {},
|
| 3688 | "sources": [
|
| 3689 | {
|
| 3690 | "fileName": "connect.ts",
|
| 3691 | "line": 105,
|
| 3692 | "character": 2
|
| 3693 | }
|
| 3694 | ],
|
| 3695 | "signatures": [
|
| 3696 | {
|
| 3697 | "id": 92,
|
| 3698 | "name": "manualFieldExtensions",
|
| 3699 | "kind": 4096,
|
| 3700 | "kindString": "Call signature",
|
| 3701 | "flags": {},
|
| 3702 | "comment": {
|
| 3703 | "shortText": "Use this function to declare new field extensions that users will be able to install\nmanually in some field",
|
| 3704 | "tags": [
|
| 3705 | {
|
| 3706 | "tag": "group",
|
| 3707 | "text": "manualFieldExtensions\n"
|
| 3708 | }
|
| 3709 | ]
|
| 3710 | },
|
| 3711 | "parameters": [
|
| 3712 | {
|
| 3713 | "id": 93,
|
| 3714 | "name": "ctx",
|
| 3715 | "kind": 32768,
|
| 3716 | "kindString": "Parameter",
|
| 3717 | "flags": {},
|
| 3718 | "type": {
|
| 3719 | "type": "reference",
|
| 3720 | "id": 272,
|
| 3721 | "name": "InitPropertiesAndMethods"
|
| 3722 | }
|
| 3723 | }
|
| 3724 | ],
|
| 3725 | "type": {
|
| 3726 | "type": "array",
|
| 3727 | "elementType": {
|
| 3728 | "type": "reference",
|
| 3729 | "id": 161,
|
| 3730 | "name": "ManualFieldExtension"
|
| 3731 | }
|
| 3732 | }
|
| 3733 | }
|
| 3734 | ]
|
| 3735 | },
|
| 3736 | {
|
| 3737 | "id": 79,
|
| 3738 | "name": "onBoot",
|
| 3739 | "kind": 2048,
|
| 3740 | "kindString": "Method",
|
| 3741 | "flags": {},
|
| 3742 | "sources": [
|
| 3743 | {
|
| 3744 | "fileName": "connect.ts",
|
| 3745 | "line": 80,
|
| 3746 | "character": 2
|
| 3747 | }
|
| 3748 | ],
|
| 3749 | "signatures": [
|
| 3750 | {
|
| 3751 | "id": 80,
|
| 3752 | "name": "onBoot",
|
| 3753 | "kind": 4096,
|
| 3754 | "kindString": "Call signature",
|
| 3755 | "flags": {},
|
| 3756 | "comment": {
|
| 3757 | "shortText": "This function will be called once at boot time and can be used to perform ie. some\ninitial integrity checks on the configuration.",
|
| 3758 | "tags": [
|
| 3759 | {
|
| 3760 | "tag": "group",
|
| 3761 | "text": "boot\n"
|
| 3762 | }
|
| 3763 | ]
|
| 3764 | },
|
| 3765 | "parameters": [
|
| 3766 | {
|
| 3767 | "id": 81,
|
| 3768 | "name": "ctx",
|
| 3769 | "kind": 32768,
|
| 3770 | "kindString": "Parameter",
|
| 3771 | "flags": {},
|
| 3772 | "type": {
|
| 3773 | "type": "reference",
|
| 3774 | "id": 535,
|
| 3775 | "name": "OnBootPropertiesAndMethods"
|
| 3776 | }
|
| 3777 | }
|
| 3778 | ],
|
| 3779 | "type": {
|
| 3780 | "type": "intrinsic",
|
| 3781 | "name": "void"
|
| 3782 | }
|
| 3783 | }
|
| 3784 | ]
|
| 3785 | },
|
| 3786 | {
|
| 3787 | "id": 98,
|
| 3788 | "name": "overrideFieldExtensions",
|
| 3789 | "kind": 2048,
|
| 3790 | "kindString": "Method",
|
| 3791 | "flags": {},
|
| 3792 | "sources": [
|
| 3793 | {
|
| 3794 | "fileName": "connect.ts",
|
| 3795 | "line": 118,
|
| 3796 | "character": 2
|
| 3797 | }
|
| 3798 | ],
|
| 3799 | "signatures": [
|
| 3800 | {
|
| 3801 | "id": 99,
|
| 3802 | "name": "overrideFieldExtensions",
|
| 3803 | "kind": 4096,
|
| 3804 | "kindString": "Call signature",
|
| 3805 | "flags": {},
|
| 3806 | "comment": {
|
| 3807 | "shortText": "Use this function to automatically force one or more field extensions to a particular field",
|
| 3808 | "tags": [
|
| 3809 | {
|
| 3810 | "tag": "group",
|
| 3811 | "text": "forcedFieldExtensions\n"
|
| 3812 | }
|
| 3813 | ]
|
| 3814 | },
|
| 3815 | "parameters": [
|
| 3816 | {
|
| 3817 | "id": 100,
|
| 3818 | "name": "field",
|
| 3819 | "kind": 32768,
|
| 3820 | "kindString": "Parameter",
|
| 3821 | "flags": {},
|
| 3822 | "type": {
|
| 3823 | "type": "reference",
|
| 3824 | "id": 5,
|
| 3825 | "name": "Field"
|
| 3826 | }
|
| 3827 | },
|
| 3828 | {
|
| 3829 | "id": 101,
|
| 3830 | "name": "ctx",
|
| 3831 | "kind": 32768,
|
| 3832 | "kindString": "Parameter",
|
| 3833 | "flags": {},
|
| 3834 | "type": {
|
| 3835 | "type": "reference",
|
| 3836 | "id": 68,
|
| 3837 | "name": "FieldIntentCtx"
|
| 3838 | }
|
| 3839 | }
|
| 3840 | ],
|
| 3841 | "type": {
|
| 3842 | "type": "union",
|
| 3843 | "types": [
|
| 3844 | {
|
| 3845 | "type": "intrinsic",
|
| 3846 | "name": "void"
|
| 3847 | },
|
| 3848 | {
|
| 3849 | "type": "reference",
|
| 3850 | "id": 200,
|
| 3851 | "name": "FieldExtensionOverride"
|
| 3852 | }
|
| 3853 | ]
|
| 3854 | }
|
| 3855 | }
|
| 3856 | ]
|
| 3857 | },
|
| 3858 | {
|
| 3859 | "id": 102,
|
| 3860 | "name": "renderConfigScreen",
|
| 3861 | "kind": 2048,
|
| 3862 | "kindString": "Method",
|
| 3863 | "flags": {},
|
| 3864 | "sources": [
|
| 3865 | {
|
| 3866 | "fileName": "connect.ts",
|
| 3867 | "line": 127,
|
| 3868 | "character": 2
|
| 3869 | }
|
| 3870 | ],
|
| 3871 | "signatures": [
|
| 3872 | {
|
| 3873 | "id": 103,
|
| 3874 | "name": "renderConfigScreen",
|
| 3875 | "kind": 4096,
|
| 3876 | "kindString": "Call signature",
|
| 3877 | "flags": {},
|
| 3878 | "comment": {
|
| 3879 | "shortText": "This function will be called when the plugin needs to render the plugin's configuration form",
|
| 3880 | "tags": [
|
| 3881 | {
|
| 3882 | "tag": "group",
|
| 3883 | "text": "configScreen\n"
|
| 3884 | }
|
| 3885 | ]
|
| 3886 | },
|
| 3887 | "parameters": [
|
| 3888 | {
|
| 3889 | "id": 104,
|
| 3890 | "name": "ctx",
|
| 3891 | "kind": 32768,
|
| 3892 | "kindString": "Parameter",
|
| 3893 | "flags": {},
|
| 3894 | "type": {
|
| 3895 | "type": "reference",
|
| 3896 | "id": 76,
|
| 3897 | "name": "RenderConfigScreenCtx"
|
| 3898 | }
|
| 3899 | }
|
| 3900 | ],
|
| 3901 | "type": {
|
| 3902 | "type": "intrinsic",
|
| 3903 | "name": "void"
|
| 3904 | }
|
| 3905 | }
|
| 3906 | ]
|
| 3907 | },
|
| 3908 | {
|
| 3909 | "id": 117,
|
| 3910 | "name": "renderFieldExtension",
|
| 3911 | "kind": 2048,
|
| 3912 | "kindString": "Method",
|
| 3913 | "flags": {},
|
| 3914 | "sources": [
|
| 3915 | {
|
| 3916 | "fileName": "connect.ts",
|
| 3917 | "line": 158,
|
| 3918 | "character": 2
|
| 3919 | }
|
| 3920 | ],
|
| 3921 | "signatures": [
|
| 3922 | {
|
| 3923 | "id": 118,
|
| 3924 | "name": "renderFieldExtension",
|
| 3925 | "kind": 4096,
|
| 3926 | "kindString": "Call signature",
|
| 3927 | "flags": {},
|
| 3928 | "comment": {
|
| 3929 | "shortText": "This function will be called when the plugin needs to render a field extension (see\nthe `manualFieldExtensions` and `overrideFieldExtensions` functions)",
|
| 3930 | "tags": [
|
| 3931 | {
|
| 3932 | "tag": "group",
|
| 3933 | "text": "forcedFieldExtensions\n"
|
| 3934 | }
|
| 3935 | ]
|
| 3936 | },
|
| 3937 | "parameters": [
|
| 3938 | {
|
| 3939 | "id": 119,
|
| 3940 | "name": "fieldExtensionId",
|
| 3941 | "kind": 32768,
|
| 3942 | "kindString": "Parameter",
|
| 3943 | "flags": {},
|
| 3944 | "type": {
|
| 3945 | "type": "intrinsic",
|
| 3946 | "name": "string"
|
| 3947 | }
|
| 3948 | },
|
| 3949 | {
|
| 3950 | "id": 120,
|
| 3951 | "name": "ctx",
|
| 3952 | "kind": 32768,
|
| 3953 | "kindString": "Parameter",
|
| 3954 | "flags": {},
|
| 3955 | "type": {
|
| 3956 | "type": "reference",
|
| 3957 | "id": 74,
|
| 3958 | "name": "RenderFieldExtensionCtx"
|
| 3959 | }
|
| 3960 | }
|
| 3961 | ],
|
| 3962 | "type": {
|
| 3963 | "type": "intrinsic",
|
| 3964 | "name": "void"
|
| 3965 | }
|
| 3966 | }
|
| 3967 | ]
|
| 3968 | },
|
| 3969 | {
|
| 3970 | "id": 113,
|
| 3971 | "name": "renderItemFormSidebarPanel",
|
| 3972 | "kind": 2048,
|
| 3973 | "kindString": "Method",
|
| 3974 | "flags": {},
|
| 3975 | "sources": [
|
| 3976 | {
|
| 3977 | "fileName": "connect.ts",
|
| 3978 | "line": 148,
|
| 3979 | "character": 2
|
| 3980 | }
|
| 3981 | ],
|
| 3982 | "signatures": [
|
| 3983 | {
|
| 3984 | "id": 114,
|
| 3985 | "name": "renderItemFormSidebarPanel",
|
| 3986 | "kind": 4096,
|
| 3987 | "kindString": "Call signature",
|
| 3988 | "flags": {},
|
| 3989 | "comment": {
|
| 3990 | "shortText": "This function will be called when the plugin needs to render a sidebar panel (see the\n`itemFormSidebarPanels` function)",
|
| 3991 | "tags": [
|
| 3992 | {
|
| 3993 | "tag": "group",
|
| 3994 | "text": "sidebarPanels\n"
|
| 3995 | }
|
| 3996 | ]
|
| 3997 | },
|
| 3998 | "parameters": [
|
| 3999 | {
|
| 4000 | "id": 115,
|
| 4001 | "name": "sidebarPaneId",
|
| 4002 | "kind": 32768,
|
| 4003 | "kindString": "Parameter",
|
| 4004 | "flags": {},
|
| 4005 | "type": {
|
| 4006 | "type": "intrinsic",
|
| 4007 | "name": "string"
|
| 4008 | }
|
| 4009 | },
|
| 4010 | {
|
| 4011 | "id": 116,
|
| 4012 | "name": "ctx",
|
| 4013 | "kind": 32768,
|
| 4014 | "kindString": "Parameter",
|
| 4015 | "flags": {},
|
| 4016 | "type": {
|
| 4017 | "type": "reference",
|
| 4018 | "id": 73,
|
| 4019 | "name": "RenderItemFormSidebarPanelCtx"
|
| 4020 | }
|
| 4021 | }
|
| 4022 | ],
|
| 4023 | "type": {
|
| 4024 | "type": "intrinsic",
|
| 4025 | "name": "void"
|
| 4026 | }
|
| 4027 | }
|
| 4028 | ]
|
| 4029 | },
|
| 4030 | {
|
| 4031 | "id": 121,
|
| 4032 | "name": "renderManualFieldExtensionConfigScreen",
|
| 4033 | "kind": 2048,
|
| 4034 | "kindString": "Method",
|
| 4035 | "flags": {},
|
| 4036 | "sources": [
|
| 4037 | {
|
| 4038 | "fileName": "connect.ts",
|
| 4039 | "line": 165,
|
| 4040 | "character": 2
|
| 4041 | }
|
| 4042 | ],
|
| 4043 | "signatures": [
|
| 4044 | {
|
| 4045 | "id": 122,
|
| 4046 | "name": "renderManualFieldExtensionConfigScreen",
|
| 4047 | "kind": 4096,
|
| 4048 | "kindString": "Call signature",
|
| 4049 | "flags": {},
|
| 4050 | "comment": {
|
| 4051 | "shortText": "This function will be called when the plugin needs to render the configuration form\nfor installing a field extension inside a particular field",
|
| 4052 | "tags": [
|
| 4053 | {
|
| 4054 | "tag": "group",
|
| 4055 | "text": "manualFieldExtensions\n"
|
| 4056 | }
|
| 4057 | ]
|
| 4058 | },
|
| 4059 | "parameters": [
|
| 4060 | {
|
| 4061 | "id": 123,
|
| 4062 | "name": "fieldExtensionId",
|
| 4063 | "kind": 32768,
|
| 4064 | "kindString": "Parameter",
|
| 4065 | "flags": {},
|
| 4066 | "type": {
|
| 4067 | "type": "intrinsic",
|
| 4068 | "name": "string"
|
| 4069 | }
|
| 4070 | },
|
| 4071 | {
|
| 4072 | "id": 124,
|
| 4073 | "name": "ctx",
|
| 4074 | "kind": 32768,
|
| 4075 | "kindString": "Parameter",
|
| 4076 | "flags": {},
|
| 4077 | "type": {
|
| 4078 | "type": "reference",
|
| 4079 | "id": 75,
|
| 4080 | "name": "RenderManualFieldExtensionConfigScreenCtx"
|
| 4081 | }
|
| 4082 | }
|
| 4083 | ],
|
| 4084 | "type": {
|
| 4085 | "type": "intrinsic",
|
| 4086 | "name": "void"
|
| 4087 | }
|
| 4088 | }
|
| 4089 | ]
|
| 4090 | },
|
| 4091 | {
|
| 4092 | "id": 109,
|
| 4093 | "name": "renderModal",
|
| 4094 | "kind": 2048,
|
| 4095 | "kindString": "Method",
|
| 4096 | "flags": {},
|
| 4097 | "sources": [
|
| 4098 | {
|
| 4099 | "fileName": "connect.ts",
|
| 4100 | "line": 141,
|
| 4101 | "character": 2
|
| 4102 | }
|
| 4103 | ],
|
| 4104 | "signatures": [
|
| 4105 | {
|
| 4106 | "id": 110,
|
| 4107 | "name": "renderModal",
|
| 4108 | "kind": 4096,
|
| 4109 | "kindString": "Call signature",
|
| 4110 | "flags": {},
|
| 4111 | "comment": {
|
| 4112 | "shortText": "This function will be called when the plugin requested to open a modal (see the\n`openModal` function)",
|
| 4113 | "tags": [
|
| 4114 | {
|
| 4115 | "tag": "group",
|
| 4116 | "text": "modals\n"
|
| 4117 | }
|
| 4118 | ]
|
| 4119 | },
|
| 4120 | "parameters": [
|
| 4121 | {
|
| 4122 | "id": 111,
|
| 4123 | "name": "modalId",
|
| 4124 | "kind": 32768,
|
| 4125 | "kindString": "Parameter",
|
| 4126 | "flags": {},
|
| 4127 | "type": {
|
| 4128 | "type": "intrinsic",
|
| 4129 | "name": "string"
|
| 4130 | }
|
| 4131 | },
|
| 4132 | {
|
| 4133 | "id": 112,
|
| 4134 | "name": "ctx",
|
| 4135 | "kind": 32768,
|
| 4136 | "kindString": "Parameter",
|
| 4137 | "flags": {},
|
| 4138 | "type": {
|
| 4139 | "type": "reference",
|
| 4140 | "id": 72,
|
| 4141 | "name": "RenderModalCtx"
|
| 4142 | }
|
| 4143 | }
|
| 4144 | ],
|
| 4145 | "type": {
|
| 4146 | "type": "intrinsic",
|
| 4147 | "name": "void"
|
| 4148 | }
|
| 4149 | }
|
| 4150 | ]
|
| 4151 | },
|
| 4152 | {
|
| 4153 | "id": 105,
|
| 4154 | "name": "renderPage",
|
| 4155 | "kind": 2048,
|
| 4156 | "kindString": "Method",
|
| 4157 | "flags": {},
|
| 4158 | "sources": [
|
| 4159 | {
|
| 4160 | "fileName": "connect.ts",
|
| 4161 | "line": 134,
|
| 4162 | "character": 2
|
| 4163 | }
|
| 4164 | ],
|
| 4165 | "signatures": [
|
| 4166 | {
|
| 4167 | "id": 106,
|
| 4168 | "name": "renderPage",
|
| 4169 | "kind": 4096,
|
| 4170 | "kindString": "Call signature",
|
| 4171 | "flags": {},
|
| 4172 | "comment": {
|
| 4173 | "shortText": "This function will be called when the plugin needs to render a specific page (see the\n`mainNavigationTabs`, `settingsAreaSidebarItemGroups` and `contentAreaSidebarItems` functions)",
|
| 4174 | "tags": [
|
| 4175 | {
|
| 4176 | "tag": "group",
|
| 4177 | "text": "pages\n"
|
| 4178 | }
|
| 4179 | ]
|
| 4180 | },
|
| 4181 | "parameters": [
|
| 4182 | {
|
| 4183 | "id": 107,
|
| 4184 | "name": "pageId",
|
| 4185 | "kind": 32768,
|
| 4186 | "kindString": "Parameter",
|
| 4187 | "flags": {},
|
| 4188 | "type": {
|
| 4189 | "type": "intrinsic",
|
| 4190 | "name": "string"
|
| 4191 | }
|
| 4192 | },
|
| 4193 | {
|
| 4194 | "id": 108,
|
| 4195 | "name": "ctx",
|
| 4196 | "kind": 32768,
|
| 4197 | "kindString": "Parameter",
|
| 4198 | "flags": {},
|
| 4199 | "type": {
|
| 4200 | "type": "reference",
|
| 4201 | "id": 483,
|
| 4202 | "name": "RenderPagePropertiesAndMethods"
|
| 4203 | }
|
| 4204 | }
|
| 4205 | ],
|
| 4206 | "type": {
|
| 4207 | "type": "intrinsic",
|
| 4208 | "name": "void"
|
| 4209 | }
|
| 4210 | }
|
| 4211 | ]
|
| 4212 | },
|
| 4213 | {
|
| 4214 | "id": 85,
|
| 4215 | "name": "settingsAreaSidebarItemGroups",
|
| 4216 | "kind": 2048,
|
| 4217 | "kindString": "Method",
|
| 4218 | "flags": {},
|
| 4219 | "sources": [
|
| 4220 | {
|
| 4221 | "fileName": "connect.ts",
|
| 4222 | "line": 92,
|
| 4223 | "character": 2
|
| 4224 | }
|
| 4225 | ],
|
| 4226 | "signatures": [
|
| 4227 | {
|
| 4228 | "id": 86,
|
| 4229 | "name": "settingsAreaSidebarItemGroups",
|
| 4230 | "kind": 4096,
|
| 4231 | "kindString": "Call signature",
|
| 4232 | "flags": {},
|
| 4233 | "comment": {
|
| 4234 | "shortText": "Use this function to declare new navigation sections in the Settings Area sidebar",
|
| 4235 | "tags": [
|
| 4236 | {
|
| 4237 | "tag": "group",
|
| 4238 | "text": "pages\n"
|
| 4239 | }
|
| 4240 | ]
|
| 4241 | },
|
| 4242 | "parameters": [
|
| 4243 | {
|
| 4244 | "id": 87,
|
| 4245 | "name": "ctx",
|
| 4246 | "kind": 32768,
|
| 4247 | "kindString": "Parameter",
|
| 4248 | "flags": {},
|
| 4249 | "type": {
|
| 4250 | "type": "reference",
|
| 4251 | "id": 272,
|
| 4252 | "name": "InitPropertiesAndMethods"
|
| 4253 | }
|
| 4254 | }
|
| 4255 | ],
|
| 4256 | "type": {
|
| 4257 | "type": "array",
|
| 4258 | "elementType": {
|
| 4259 | "type": "reference",
|
| 4260 | "id": 145,
|
| 4261 | "name": "SettingsAreaSidebarItemGroup"
|
| 4262 | }
|
| 4263 | }
|
| 4264 | }
|
| 4265 | ]
|
| 4266 | },
|
| 4267 | {
|
| 4268 | "id": 125,
|
| 4269 | "name": "validateManualFieldExtensionParameters",
|
| 4270 | "kind": 2048,
|
| 4271 | "kindString": "Method",
|
| 4272 | "flags": {},
|
| 4273 | "sources": [
|
| 4274 | {
|
| 4275 | "fileName": "connect.ts",
|
| 4276 | "line": 175,
|
| 4277 | "character": 2
|
| 4278 | }
|
| 4279 | ],
|
| 4280 | "signatures": [
|
| 4281 | {
|
| 4282 | "id": 126,
|
| 4283 | "name": "validateManualFieldExtensionParameters",
|
| 4284 | "kind": 4096,
|
| 4285 | "kindString": "Call signature",
|
| 4286 | "flags": {},
|
| 4287 | "comment": {
|
| 4288 | "shortText": "This function will be called each time the configuration object changes. It must\nreturn an object containing possible validation errors",
|
| 4289 | "tags": [
|
| 4290 | {
|
| 4291 | "tag": "group",
|
| 4292 | "text": "manualFieldExtensions\n"
|
| 4293 | }
|
| 4294 | ]
|
| 4295 | },
|
| 4296 | "parameters": [
|
| 4297 | {
|
| 4298 | "id": 127,
|
| 4299 | "name": "fieldExtensionId",
|
| 4300 | "kind": 32768,
|
| 4301 | "kindString": "Parameter",
|
| 4302 | "flags": {},
|
| 4303 | "type": {
|
| 4304 | "type": "intrinsic",
|
| 4305 | "name": "string"
|
| 4306 | }
|
| 4307 | },
|
| 4308 | {
|
| 4309 | "id": 128,
|
| 4310 | "name": "parameters",
|
| 4311 | "kind": 32768,
|
| 4312 | "kindString": "Parameter",
|
| 4313 | "flags": {},
|
| 4314 | "type": {
|
| 4315 | "type": "reference",
|
| 4316 | "typeArguments": [
|
| 4317 | {
|
| 4318 | "type": "intrinsic",
|
| 4319 | "name": "string"
|
| 4320 | },
|
| 4321 | {
|
| 4322 | "type": "intrinsic",
|
| 4323 | "name": "unknown"
|
| 4324 | }
|
| 4325 | ],
|
| 4326 | "name": "Record"
|
| 4327 | }
|
| 4328 | }
|
| 4329 | ],
|
| 4330 | "type": {
|
| 4331 | "type": "union",
|
| 4332 | "types": [
|
| 4333 | {
|
| 4334 | "type": "reference",
|
| 4335 | "typeArguments": [
|
| 4336 | {
|
| 4337 | "type": "intrinsic",
|
| 4338 | "name": "string"
|
| 4339 | },
|
| 4340 | {
|
| 4341 | "type": "intrinsic",
|
| 4342 | "name": "unknown"
|
| 4343 | }
|
| 4344 | ],
|
| 4345 | "name": "Record"
|
| 4346 | },
|
| 4347 | {
|
| 4348 | "type": "reference",
|
| 4349 | "typeArguments": [
|
| 4350 | {
|
| 4351 | "type": "reference",
|
| 4352 | "typeArguments": [
|
| 4353 | {
|
| 4354 | "type": "intrinsic",
|
| 4355 | "name": "string"
|
| 4356 | },
|
| 4357 | {
|
| 4358 | "type": "intrinsic",
|
| 4359 | "name": "unknown"
|
| 4360 | }
|
| 4361 | ],
|
| 4362 | "name": "Record"
|
| 4363 | }
|
| 4364 | ],
|
| 4365 | "name": "Promise"
|
| 4366 | }
|
| 4367 | ]
|
| 4368 | }
|
| 4369 | }
|
| 4370 | ]
|
| 4371 | }
|
| 4372 | ],
|
| 4373 | "groups": [
|
| 4374 | {
|
| 4375 | "title": "Methods",
|
| 4376 | "kind": 2048,
|
| 4377 | "children": [
|
| 4378 | 88,
|
| 4379 | 94,
|
| 4380 | 82,
|
| 4381 | 91,
|
| 4382 | 79,
|
| 4383 | 98,
|
| 4384 | 102,
|
| 4385 | 117,
|
| 4386 | 113,
|
| 4387 | 121,
|
| 4388 | 109,
|
| 4389 | 105,
|
| 4390 | 85,
|
| 4391 | 125
|
| 4392 | ]
|
| 4393 | }
|
| 4394 | ],
|
| 4395 | "sources": [
|
| 4396 | {
|
| 4397 | "fileName": "connect.ts",
|
| 4398 | "line": 73,
|
| 4399 | "character": 36
|
| 4400 | }
|
| 4401 | ]
|
| 4402 | }
|
| 4403 | }
|
| 4404 | },
|
| 4405 | {
|
| 4406 | "id": 392,
|
| 4407 | "name": "IframeMethods",
|
| 4408 | "kind": 4194304,
|
| 4409 | "kindString": "Type alias",
|
| 4410 | "flags": {},
|
| 4411 | "comment": {
|
| 4412 | "shortText": "These methods can be used to set various properties of the containing iframe"
|
| 4413 | },
|
| 4414 | "sources": [
|
| 4415 | {
|
| 4416 | "fileName": "types.ts",
|
| 4417 | "line": 941,
|
| 4418 | "character": 12
|
| 4419 | }
|
| 4420 | ],
|
| 4421 | "type": {
|
| 4422 | "type": "reflection",
|
| 4423 | "declaration": {
|
| 4424 | "id": 393,
|
| 4425 | "name": "__type",
|
| 4426 | "kind": 65536,
|
| 4427 | "kindString": "Type literal",
|
| 4428 | "flags": {},
|
| 4429 | "children": [
|
| 4430 | {
|
| 4431 | "id": 394,
|
| 4432 | "name": "setHeight",
|
| 4433 | "kind": 2048,
|
| 4434 | "kindString": "Method",
|
| 4435 | "flags": {},
|
| 4436 | "sources": [
|
| 4437 | {
|
| 4438 | "fileName": "types.ts",
|
| 4439 | "line": 943,
|
| 4440 | "character": 2
|
| 4441 | }
|
| 4442 | ],
|
| 4443 | "signatures": [
|
| 4444 | {
|
| 4445 | "id": 395,
|
| 4446 | "name": "setHeight",
|
| 4447 | "kind": 4096,
|
| 4448 | "kindString": "Call signature",
|
| 4449 | "flags": {},
|
| 4450 | "comment": {
|
| 4451 | "shortText": "Sets the height for the iframe"
|
| 4452 | },
|
| 4453 | "parameters": [
|
| 4454 | {
|
| 4455 | "id": 396,
|
| 4456 | "name": "number",
|
| 4457 | "kind": 32768,
|
| 4458 | "kindString": "Parameter",
|
| 4459 | "flags": {},
|
| 4460 | "type": {
|
| 4461 | "type": "intrinsic",
|
| 4462 | "name": "number"
|
| 4463 | }
|
| 4464 | }
|
| 4465 | ],
|
| 4466 | "type": {
|
| 4467 | "type": "reference",
|
| 4468 | "typeArguments": [
|
| 4469 | {
|
| 4470 | "type": "intrinsic",
|
| 4471 | "name": "void"
|
| 4472 | }
|
| 4473 | ],
|
| 4474 | "name": "Promise"
|
| 4475 | }
|
| 4476 | }
|
| 4477 | ]
|
| 4478 | }
|
| 4479 | ],
|
| 4480 | "groups": [
|
| 4481 | {
|
| 4482 | "title": "Methods",
|
| 4483 | "kind": 2048,
|
| 4484 | "children": [
|
| 4485 | 394
|
| 4486 | ]
|
| 4487 | }
|
| 4488 | ],
|
| 4489 | "sources": [
|
| 4490 | {
|
| 4491 | "fileName": "types.ts",
|
| 4492 | "line": 941,
|
| 4493 | "character": 28
|
| 4494 | }
|
| 4495 | ]
|
| 4496 | }
|
| 4497 | }
|
| 4498 | },
|
| 4499 | {
|
| 4500 | "id": 264,
|
| 4501 | "name": "InitAdditionalProperties",
|
| 4502 | "kind": 4194304,
|
| 4503 | "kindString": "Type alias",
|
| 4504 | "flags": {},
|
| 4505 | "sources": [
|
| 4506 | {
|
| 4507 | "fileName": "types.ts",
|
| 4508 | "line": 431,
|
| 4509 | "character": 12
|
| 4510 | }
|
| 4511 | ],
|
| 4512 | "type": {
|
| 4513 | "type": "reflection",
|
| 4514 | "declaration": {
|
| 4515 | "id": 265,
|
| 4516 | "name": "__type",
|
| 4517 | "kind": 65536,
|
| 4518 | "kindString": "Type literal",
|
| 4519 | "flags": {},
|
| 4520 | "children": [
|
| 4521 | {
|
| 4522 | "id": 266,
|
| 4523 | "name": "mode",
|
| 4524 | "kind": 1024,
|
| 4525 | "kindString": "Property",
|
| 4526 | "flags": {},
|
| 4527 | "sources": [
|
| 4528 | {
|
| 4529 | "fileName": "types.ts",
|
| 4530 | "line": 432,
|
| 4531 | "character": 2
|
| 4532 | }
|
| 4533 | ],
|
| 4534 | "type": {
|
| 4535 | "type": "literal",
|
| 4536 | "value": "init"
|
| 4537 | }
|
| 4538 | }
|
| 4539 | ],
|
| 4540 | "groups": [
|
| 4541 | {
|
| 4542 | "title": "Properties",
|
| 4543 | "kind": 1024,
|
| 4544 | "children": [
|
| 4545 | 266
|
| 4546 | ]
|
| 4547 | }
|
| 4548 | ],
|
| 4549 | "sources": [
|
| 4550 | {
|
| 4551 | "fileName": "types.ts",
|
| 4552 | "line": 431,
|
| 4553 | "character": 39
|
| 4554 | }
|
| 4555 | ]
|
| 4556 | }
|
| 4557 | }
|
| 4558 | },
|
| 4559 | {
|
| 4560 | "id": 268,
|
| 4561 | "name": "InitMethods",
|
| 4562 | "kind": 4194304,
|
| 4563 | "kindString": "Type alias",
|
| 4564 | "flags": {},
|
| 4565 | "sources": [
|
| 4566 | {
|
| 4567 | "fileName": "types.ts",
|
| 4568 | "line": 437,
|
| 4569 | "character": 12
|
| 4570 | }
|
| 4571 | ],
|
| 4572 | "type": {
|
| 4573 | "type": "reflection",
|
| 4574 | "declaration": {
|
| 4575 | "id": 269,
|
| 4576 | "name": "__type",
|
| 4577 | "kind": 65536,
|
| 4578 | "kindString": "Type literal",
|
| 4579 | "flags": {},
|
| 4580 | "children": [
|
| 4581 | {
|
| 4582 | "id": 270,
|
| 4583 | "name": "getSettings",
|
| 4584 | "kind": 2048,
|
| 4585 | "kindString": "Method",
|
| 4586 | "flags": {},
|
| 4587 | "sources": [
|
| 4588 | {
|
| 4589 | "fileName": "types.ts",
|
| 4590 | "line": 438,
|
| 4591 | "character": 2
|
| 4592 | }
|
| 4593 | ],
|
| 4594 | "signatures": [
|
| 4595 | {
|
| 4596 | "id": 271,
|
| 4597 | "name": "getSettings",
|
| 4598 | "kind": 4096,
|
| 4599 | "kindString": "Call signature",
|
| 4600 | "flags": {},
|
| 4601 | "type": {
|
| 4602 | "type": "reference",
|
| 4603 | "typeArguments": [
|
| 4604 | {
|
| 4605 | "type": "reference",
|
| 4606 | "id": 267,
|
| 4607 | "name": "InitProperties"
|
| 4608 | }
|
| 4609 | ],
|
| 4610 | "name": "Promise"
|
| 4611 | }
|
| 4612 | }
|
| 4613 | ]
|
| 4614 | }
|
| 4615 | ],
|
| 4616 | "groups": [
|
| 4617 | {
|
| 4618 | "title": "Methods",
|
| 4619 | "kind": 2048,
|
| 4620 | "children": [
|
| 4621 | 270
|
| 4622 | ]
|
| 4623 | }
|
| 4624 | ],
|
| 4625 | "sources": [
|
| 4626 | {
|
| 4627 | "fileName": "types.ts",
|
| 4628 | "line": 437,
|
| 4629 | "character": 26
|
| 4630 | }
|
| 4631 | ]
|
| 4632 | }
|
| 4633 | }
|
| 4634 | },
|
| 4635 | {
|
| 4636 | "id": 267,
|
| 4637 | "name": "InitProperties",
|
| 4638 | "kind": 4194304,
|
| 4639 | "kindString": "Type alias",
|
| 4640 | "flags": {},
|
| 4641 | "sources": [
|
| 4642 | {
|
| 4643 | "fileName": "types.ts",
|
| 4644 | "line": 435,
|
| 4645 | "character": 12
|
| 4646 | }
|
| 4647 | ],
|
| 4648 | "type": {
|
| 4649 | "type": "intersection",
|
| 4650 | "types": [
|
| 4651 | {
|
| 4652 | "type": "reference",
|
| 4653 | "id": 252,
|
| 4654 | "name": "CommonProperties"
|
| 4655 | },
|
| 4656 | {
|
| 4657 | "type": "reference",
|
| 4658 | "id": 264,
|
| 4659 | "name": "InitAdditionalProperties"
|
| 4660 | }
|
| 4661 | ]
|
| 4662 | }
|
| 4663 | },
|
| 4664 | {
|
| 4665 | "id": 272,
|
| 4666 | "name": "InitPropertiesAndMethods",
|
| 4667 | "kind": 4194304,
|
| 4668 | "kindString": "Type alias",
|
| 4669 | "flags": {},
|
| 4670 | "sources": [
|
| 4671 | {
|
| 4672 | "fileName": "types.ts",
|
| 4673 | "line": 441,
|
| 4674 | "character": 12
|
| 4675 | }
|
| 4676 | ],
|
| 4677 | "type": {
|
| 4678 | "type": "intersection",
|
| 4679 | "types": [
|
| 4680 | {
|
| 4681 | "type": "reference",
|
| 4682 | "id": 268,
|
| 4683 | "name": "InitMethods"
|
| 4684 | },
|
| 4685 | {
|
| 4686 | "type": "reference",
|
| 4687 | "id": 267,
|
| 4688 | "name": "InitProperties"
|
| 4689 | }
|
| 4690 | ]
|
| 4691 | }
|
| 4692 | },
|
| 4693 | {
|
| 4694 | "id": 66,
|
| 4695 | "name": "IntentCtx",
|
| 4696 | "kind": 4194304,
|
| 4697 | "kindString": "Type alias",
|
| 4698 | "flags": {},
|
| 4699 | "sources": [
|
| 4700 | {
|
| 4701 | "fileName": "connect.ts",
|
| 4702 | "line": 56,
|
| 4703 | "character": 12
|
| 4704 | }
|
| 4705 | ],
|
| 4706 | "type": {
|
| 4707 | "type": "reference",
|
| 4708 | "id": 272,
|
| 4709 | "name": "InitPropertiesAndMethods"
|
| 4710 | }
|
| 4711 | },
|
| 4712 | {
|
| 4713 | "id": 326,
|
| 4714 | "name": "ItemDialogMethods",
|
| 4715 | "kind": 4194304,
|
| 4716 | "kindString": "Type alias",
|
| 4717 | "flags": {},
|
| 4718 | "comment": {
|
| 4719 | "shortText": "These methods let you open the standard DatoCMS dialogs needed to interact with records"
|
| 4720 | },
|
| 4721 | "sources": [
|
| 4722 | {
|
| 4723 | "fileName": "types.ts",
|
| 4724 | "line": 652,
|
| 4725 | "character": 12
|
| 4726 | }
|
| 4727 | ],
|
| 4728 | "type": {
|
| 4729 | "type": "reflection",
|
| 4730 | "declaration": {
|
| 4731 | "id": 327,
|
| 4732 | "name": "__type",
|
| 4733 | "kind": 65536,
|
| 4734 | "kindString": "Type literal",
|
| 4735 | "flags": {},
|
| 4736 | "children": [
|
| 4737 | {
|
| 4738 | "id": 331,
|
| 4739 | "name": "selectItem",
|
| 4740 | "kind": 1024,
|
| 4741 | "kindString": "Property",
|
| 4742 | "flags": {},
|
| 4743 | "sources": [
|
| 4744 | {
|
| 4745 | "fileName": "types.ts",
|
| 4746 | "line": 693,
|
| 4747 | "character": 2
|
| 4748 | }
|
| 4749 | ],
|
| 4750 | "type": {
|
| 4751 | "type": "reflection",
|
| 4752 | "declaration": {
|
| 4753 | "id": 332,
|
| 4754 | "name": "__type",
|
| 4755 | "kind": 65536,
|
| 4756 | "kindString": "Type literal",
|
| 4757 | "flags": {},
|
| 4758 | "sources": [
|
| 4759 | {
|
| 4760 | "fileName": "types.ts",
|
| 4761 | "line": 693,
|
| 4762 | "character": 14
|
| 4763 | }
|
| 4764 | ],
|
| 4765 | "signatures": [
|
| 4766 | {
|
| 4767 | "id": 333,
|
| 4768 | "name": "__type",
|
| 4769 | "kind": 4096,
|
| 4770 | "kindString": "Call signature",
|
| 4771 | "flags": {},
|
| 4772 | "comment": {
|
| 4773 | "shortText": "Opens a dialog for selecting one (or multiple) record(s) from a list of\nexisting records of type `itemTypeId`. It returns a promise resolved with\nthe selected record(s), or `null` if the user closes the dialog without\nchoosing any record.",
|
| 4774 | "tags": [
|
| 4775 | {
|
| 4776 | "tag": "example",
|
| 4777 | "text": "\n\n```js\nconst itemTypeId = prompt('Please insert a model ID:');\n\nconst items = await ctx.selectItem(itemTypeId, { multiple: true });\n\nif (items) {\n ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 4778 | }
|
| 4779 | ]
|
| 4780 | },
|
| 4781 | "parameters": [
|
| 4782 | {
|
| 4783 | "id": 334,
|
| 4784 | "name": "itemTypeId",
|
| 4785 | "kind": 32768,
|
| 4786 | "kindString": "Parameter",
|
| 4787 | "flags": {},
|
| 4788 | "type": {
|
| 4789 | "type": "intrinsic",
|
| 4790 | "name": "string"
|
| 4791 | }
|
| 4792 | },
|
| 4793 | {
|
| 4794 | "id": 335,
|
| 4795 | "name": "options",
|
| 4796 | "kind": 32768,
|
| 4797 | "kindString": "Parameter",
|
| 4798 | "flags": {},
|
| 4799 | "type": {
|
| 4800 | "type": "reflection",
|
| 4801 | "declaration": {
|
| 4802 | "id": 336,
|
| 4803 | "name": "__type",
|
| 4804 | "kind": 65536,
|
| 4805 | "kindString": "Type literal",
|
| 4806 | "flags": {},
|
| 4807 | "children": [
|
| 4808 | {
|
| 4809 | "id": 337,
|
| 4810 | "name": "multiple",
|
| 4811 | "kind": 1024,
|
| 4812 | "kindString": "Property",
|
| 4813 | "flags": {},
|
| 4814 | "sources": [
|
| 4815 | {
|
| 4816 | "fileName": "types.ts",
|
| 4817 | "line": 694,
|
| 4818 | "character": 36
|
| 4819 | }
|
| 4820 | ],
|
| 4821 | "type": {
|
| 4822 | "type": "literal",
|
| 4823 | "value": true
|
| 4824 | }
|
| 4825 | }
|
| 4826 | ],
|
| 4827 | "groups": [
|
| 4828 | {
|
| 4829 | "title": "Properties",
|
| 4830 | "kind": 1024,
|
| 4831 | "children": [
|
| 4832 | 337
|
| 4833 | ]
|
| 4834 | }
|
| 4835 | ]
|
| 4836 | }
|
| 4837 | }
|
| 4838 | }
|
| 4839 | ],
|
| 4840 | "type": {
|
| 4841 | "type": "reference",
|
| 4842 | "typeArguments": [
|
| 4843 | {
|
| 4844 | "type": "union",
|
| 4845 | "types": [
|
| 4846 | {
|
| 4847 | "type": "literal",
|
| 4848 | "value": null
|
| 4849 | },
|
| 4850 | {
|
| 4851 | "type": "array",
|
| 4852 | "elementType": {
|
| 4853 | "type": "reference",
|
| 4854 | "id": 10,
|
| 4855 | "name": "Item"
|
| 4856 | }
|
| 4857 | }
|
| 4858 | ]
|
| 4859 | }
|
| 4860 | ],
|
| 4861 | "name": "Promise"
|
| 4862 | }
|
| 4863 | },
|
| 4864 | {
|
| 4865 | "id": 338,
|
| 4866 | "name": "__type",
|
| 4867 | "kind": 4096,
|
| 4868 | "kindString": "Call signature",
|
| 4869 | "flags": {},
|
| 4870 | "comment": {
|
| 4871 | "shortText": "Opens a dialog for selecting one (or multiple) record(s) from a list of\nexisting records of type `itemTypeId`. It returns a promise resolved with\nthe selected record(s), or `null` if the user closes the dialog without\nchoosing any record.",
|
| 4872 | "tags": [
|
| 4873 | {
|
| 4874 | "tag": "example",
|
| 4875 | "text": "\n\n```js\nconst itemTypeId = prompt('Please insert a model ID:');\n\nconst items = await ctx.selectItem(itemTypeId, { multiple: true });\n\nif (items) {\n ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 4876 | }
|
| 4877 | ]
|
| 4878 | },
|
| 4879 | "parameters": [
|
| 4880 | {
|
| 4881 | "id": 339,
|
| 4882 | "name": "itemTypeId",
|
| 4883 | "kind": 32768,
|
| 4884 | "kindString": "Parameter",
|
| 4885 | "flags": {},
|
| 4886 | "type": {
|
| 4887 | "type": "intrinsic",
|
| 4888 | "name": "string"
|
| 4889 | }
|
| 4890 | },
|
| 4891 | {
|
| 4892 | "id": 340,
|
| 4893 | "name": "options",
|
| 4894 | "kind": 32768,
|
| 4895 | "kindString": "Parameter",
|
| 4896 | "flags": {
|
| 4897 | "isOptional": true
|
| 4898 | },
|
| 4899 | "type": {
|
| 4900 | "type": "reflection",
|
| 4901 | "declaration": {
|
| 4902 | "id": 341,
|
| 4903 | "name": "__type",
|
| 4904 | "kind": 65536,
|
| 4905 | "kindString": "Type literal",
|
| 4906 | "flags": {},
|
| 4907 | "children": [
|
| 4908 | {
|
| 4909 | "id": 342,
|
| 4910 | "name": "multiple",
|
| 4911 | "kind": 1024,
|
| 4912 | "kindString": "Property",
|
| 4913 | "flags": {},
|
| 4914 | "sources": [
|
| 4915 | {
|
| 4916 | "fileName": "types.ts",
|
| 4917 | "line": 695,
|
| 4918 | "character": 37
|
| 4919 | }
|
| 4920 | ],
|
| 4921 | "type": {
|
| 4922 | "type": "literal",
|
| 4923 | "value": false
|
| 4924 | }
|
| 4925 | }
|
| 4926 | ],
|
| 4927 | "groups": [
|
| 4928 | {
|
| 4929 | "title": "Properties",
|
| 4930 | "kind": 1024,
|
| 4931 | "children": [
|
| 4932 | 342
|
| 4933 | ]
|
| 4934 | }
|
| 4935 | ]
|
| 4936 | }
|
| 4937 | }
|
| 4938 | }
|
| 4939 | ],
|
| 4940 | "type": {
|
| 4941 | "type": "reference",
|
| 4942 | "typeArguments": [
|
| 4943 | {
|
| 4944 | "type": "union",
|
| 4945 | "types": [
|
| 4946 | {
|
| 4947 | "type": "literal",
|
| 4948 | "value": null
|
| 4949 | },
|
| 4950 | {
|
| 4951 | "type": "reference",
|
| 4952 | "id": 10,
|
| 4953 | "name": "Item"
|
| 4954 | }
|
| 4955 | ]
|
| 4956 | }
|
| 4957 | ],
|
| 4958 | "name": "Promise"
|
| 4959 | }
|
| 4960 | }
|
| 4961 | ]
|
| 4962 | }
|
| 4963 | }
|
| 4964 | },
|
| 4965 | {
|
| 4966 | "id": 328,
|
| 4967 | "name": "createNewItem",
|
| 4968 | "kind": 2048,
|
| 4969 | "kindString": "Method",
|
| 4970 | "flags": {},
|
| 4971 | "sources": [
|
| 4972 | {
|
| 4973 | "fileName": "types.ts",
|
| 4974 | "line": 672,
|
| 4975 | "character": 2
|
| 4976 | }
|
| 4977 | ],
|
| 4978 | "signatures": [
|
| 4979 | {
|
| 4980 | "id": 329,
|
| 4981 | "name": "createNewItem",
|
| 4982 | "kind": 4096,
|
| 4983 | "kindString": "Call signature",
|
| 4984 | "flags": {},
|
| 4985 | "comment": {
|
| 4986 | "shortText": "Opens a dialog for creating a new record. It returns a promise resolved\nwith the newly created record or `null` if the user closes the dialog\nwithout creating anything.",
|
| 4987 | "tags": [
|
| 4988 | {
|
| 4989 | "tag": "example",
|
| 4990 | "text": "\n\n```js\nconst itemTypeId = prompt('Please insert a model ID:');\n\nconst item = await ctx.createNewItem(itemTypeId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 4991 | }
|
| 4992 | ]
|
| 4993 | },
|
| 4994 | "parameters": [
|
| 4995 | {
|
| 4996 | "id": 330,
|
| 4997 | "name": "itemTypeId",
|
| 4998 | "kind": 32768,
|
| 4999 | "kindString": "Parameter",
|
| 5000 | "flags": {},
|
| 5001 | "type": {
|
| 5002 | "type": "intrinsic",
|
| 5003 | "name": "string"
|
| 5004 | }
|
| 5005 | }
|
| 5006 | ],
|
| 5007 | "type": {
|
| 5008 | "type": "reference",
|
| 5009 | "typeArguments": [
|
| 5010 | {
|
| 5011 | "type": "union",
|
| 5012 | "types": [
|
| 5013 | {
|
| 5014 | "type": "literal",
|
| 5015 | "value": null
|
| 5016 | },
|
| 5017 | {
|
| 5018 | "type": "reference",
|
| 5019 | "id": 10,
|
| 5020 | "name": "Item"
|
| 5021 | }
|
| 5022 | ]
|
| 5023 | }
|
| 5024 | ],
|
| 5025 | "name": "Promise"
|
| 5026 | }
|
| 5027 | }
|
| 5028 | ]
|
| 5029 | },
|
| 5030 | {
|
| 5031 | "id": 343,
|
| 5032 | "name": "editItem",
|
| 5033 | "kind": 2048,
|
| 5034 | "kindString": "Method",
|
| 5035 | "flags": {},
|
| 5036 | "sources": [
|
| 5037 | {
|
| 5038 | "fileName": "types.ts",
|
| 5039 | "line": 716,
|
| 5040 | "character": 2
|
| 5041 | }
|
| 5042 | ],
|
| 5043 | "signatures": [
|
| 5044 | {
|
| 5045 | "id": 344,
|
| 5046 | "name": "editItem",
|
| 5047 | "kind": 4096,
|
| 5048 | "kindString": "Call signature",
|
| 5049 | "flags": {},
|
| 5050 | "comment": {
|
| 5051 | "shortText": "Opens a dialog for editing an existing record. It returns a promise\nresolved with the edited record, or `null` if the user closes the dialog\nwithout persisting any change.",
|
| 5052 | "tags": [
|
| 5053 | {
|
| 5054 | "tag": "example",
|
| 5055 | "text": "\n\n```js\nconst itemId = prompt('Please insert a record ID:');\n\nconst item = await ctx.editItem(itemId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 5056 | }
|
| 5057 | ]
|
| 5058 | },
|
| 5059 | "parameters": [
|
| 5060 | {
|
| 5061 | "id": 345,
|
| 5062 | "name": "itemId",
|
| 5063 | "kind": 32768,
|
| 5064 | "kindString": "Parameter",
|
| 5065 | "flags": {},
|
| 5066 | "type": {
|
| 5067 | "type": "intrinsic",
|
| 5068 | "name": "string"
|
| 5069 | }
|
| 5070 | }
|
| 5071 | ],
|
| 5072 | "type": {
|
| 5073 | "type": "reference",
|
| 5074 | "typeArguments": [
|
| 5075 | {
|
| 5076 | "type": "union",
|
| 5077 | "types": [
|
| 5078 | {
|
| 5079 | "type": "literal",
|
| 5080 | "value": null
|
| 5081 | },
|
| 5082 | {
|
| 5083 | "type": "reference",
|
| 5084 | "id": 10,
|
| 5085 | "name": "Item"
|
| 5086 | }
|
| 5087 | ]
|
| 5088 | }
|
| 5089 | ],
|
| 5090 | "name": "Promise"
|
| 5091 | }
|
| 5092 | }
|
| 5093 | ]
|
| 5094 | }
|
| 5095 | ],
|
| 5096 | "groups": [
|
| 5097 | {
|
| 5098 | "title": "Properties",
|
| 5099 | "kind": 1024,
|
| 5100 | "children": [
|
| 5101 | 331
|
| 5102 | ]
|
| 5103 | },
|
| 5104 | {
|
| 5105 | "title": "Methods",
|
| 5106 | "kind": 2048,
|
| 5107 | "children": [
|
| 5108 | 328,
|
| 5109 | 343
|
| 5110 | ]
|
| 5111 | }
|
| 5112 | ],
|
| 5113 | "sources": [
|
| 5114 | {
|
| 5115 | "fileName": "types.ts",
|
| 5116 | "line": 652,
|
| 5117 | "character": 32
|
| 5118 | }
|
| 5119 | ]
|
| 5120 | }
|
| 5121 | }
|
| 5122 | },
|
| 5123 | {
|
| 5124 | "id": 408,
|
| 5125 | "name": "ItemFormAdditionalMethods",
|
| 5126 | "kind": 4194304,
|
| 5127 | "kindString": "Type alias",
|
| 5128 | "flags": {},
|
| 5129 | "comment": {
|
| 5130 | "shortText": "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record"
|
| 5131 | },
|
| 5132 | "sources": [
|
| 5133 | {
|
| 5134 | "fileName": "types.ts",
|
| 5135 | "line": 980,
|
| 5136 | "character": 12
|
| 5137 | }
|
| 5138 | ],
|
| 5139 | "type": {
|
| 5140 | "type": "reflection",
|
| 5141 | "declaration": {
|
| 5142 | "id": 409,
|
| 5143 | "name": "__type",
|
| 5144 | "kind": 65536,
|
| 5145 | "kindString": "Type literal",
|
| 5146 | "flags": {},
|
| 5147 | "children": [
|
| 5148 | {
|
| 5149 | "id": 414,
|
| 5150 | "name": "disableField",
|
| 5151 | "kind": 2048,
|
| 5152 | "kindString": "Method",
|
| 5153 | "flags": {},
|
| 5154 | "sources": [
|
| 5155 | {
|
| 5156 | "fileName": "types.ts",
|
| 5157 | "line": 1010,
|
| 5158 | "character": 2
|
| 5159 | }
|
| 5160 | ],
|
| 5161 | "signatures": [
|
| 5162 | {
|
| 5163 | "id": 415,
|
| 5164 | "name": "disableField",
|
| 5165 | "kind": 4096,
|
| 5166 | "kindString": "Call signature",
|
| 5167 | "flags": {},
|
| 5168 | "comment": {
|
| 5169 | "shortText": "Disables/re-enables a specific field in the form",
|
| 5170 | "tags": [
|
| 5171 | {
|
| 5172 | "tag": "example",
|
| 5173 | "text": "\n\n```js\nconst fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);\n```\n"
|
| 5174 | }
|
| 5175 | ]
|
| 5176 | },
|
| 5177 | "parameters": [
|
| 5178 | {
|
| 5179 | "id": 416,
|
| 5180 | "name": "path",
|
| 5181 | "kind": 32768,
|
| 5182 | "kindString": "Parameter",
|
| 5183 | "flags": {},
|
| 5184 | "type": {
|
| 5185 | "type": "intrinsic",
|
| 5186 | "name": "string"
|
| 5187 | }
|
| 5188 | },
|
| 5189 | {
|
| 5190 | "id": 417,
|
| 5191 | "name": "disable",
|
| 5192 | "kind": 32768,
|
| 5193 | "kindString": "Parameter",
|
| 5194 | "flags": {},
|
| 5195 | "type": {
|
| 5196 | "type": "intrinsic",
|
| 5197 | "name": "boolean"
|
| 5198 | }
|
| 5199 | }
|
| 5200 | ],
|
| 5201 | "type": {
|
| 5202 | "type": "reference",
|
| 5203 | "typeArguments": [
|
| 5204 | {
|
| 5205 | "type": "intrinsic",
|
| 5206 | "name": "void"
|
| 5207 | }
|
| 5208 | ],
|
| 5209 | "name": "Promise"
|
| 5210 | }
|
| 5211 | }
|
| 5212 | ]
|
| 5213 | },
|
| 5214 | {
|
| 5215 | "id": 426,
|
| 5216 | "name": "saveCurrentItem",
|
| 5217 | "kind": 2048,
|
| 5218 | "kindString": "Method",
|
| 5219 | "flags": {},
|
| 5220 | "sources": [
|
| 5221 | {
|
| 5222 | "fileName": "types.ts",
|
| 5223 | "line": 1051,
|
| 5224 | "character": 2
|
| 5225 | }
|
| 5226 | ],
|
| 5227 | "signatures": [
|
| 5228 | {
|
| 5229 | "id": 427,
|
| 5230 | "name": "saveCurrentItem",
|
| 5231 | "kind": 4096,
|
| 5232 | "kindString": "Call signature",
|
| 5233 | "flags": {},
|
| 5234 | "comment": {
|
| 5235 | "shortText": "Triggers a submit form for current record",
|
| 5236 | "tags": [
|
| 5237 | {
|
| 5238 | "tag": "example",
|
| 5239 | "text": "\n\n```js\nawait ctx.saveCurrentItem();\n```\n"
|
| 5240 | }
|
| 5241 | ]
|
| 5242 | },
|
| 5243 | "type": {
|
| 5244 | "type": "reference",
|
| 5245 | "typeArguments": [
|
| 5246 | {
|
| 5247 | "type": "intrinsic",
|
| 5248 | "name": "void"
|
| 5249 | }
|
| 5250 | ],
|
| 5251 | "name": "Promise"
|
| 5252 | }
|
| 5253 | }
|
| 5254 | ]
|
| 5255 | },
|
| 5256 | {
|
| 5257 | "id": 418,
|
| 5258 | "name": "scrollToField",
|
| 5259 | "kind": 2048,
|
| 5260 | "kindString": "Method",
|
| 5261 | "flags": {},
|
| 5262 | "sources": [
|
| 5263 | {
|
| 5264 | "fileName": "types.ts",
|
| 5265 | "line": 1026,
|
| 5266 | "character": 2
|
| 5267 | }
|
| 5268 | ],
|
| 5269 | "signatures": [
|
| 5270 | {
|
| 5271 | "id": 419,
|
| 5272 | "name": "scrollToField",
|
| 5273 | "kind": 4096,
|
| 5274 | "kindString": "Call signature",
|
| 5275 | "flags": {},
|
| 5276 | "comment": {
|
| 5277 | "shortText": "Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen field.",
|
| 5278 | "tags": [
|
| 5279 | {
|
| 5280 | "tag": "example",
|
| 5281 | "text": "\n\n```js\nconst fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);\n```\n"
|
| 5282 | }
|
| 5283 | ]
|
| 5284 | },
|
| 5285 | "parameters": [
|
| 5286 | {
|
| 5287 | "id": 420,
|
| 5288 | "name": "path",
|
| 5289 | "kind": 32768,
|
| 5290 | "kindString": "Parameter",
|
| 5291 | "flags": {},
|
| 5292 | "type": {
|
| 5293 | "type": "intrinsic",
|
| 5294 | "name": "string"
|
| 5295 | }
|
| 5296 | },
|
| 5297 | {
|
| 5298 | "id": 421,
|
| 5299 | "name": "locale",
|
| 5300 | "kind": 32768,
|
| 5301 | "kindString": "Parameter",
|
| 5302 | "flags": {
|
| 5303 | "isOptional": true
|
| 5304 | },
|
| 5305 | "type": {
|
| 5306 | "type": "intrinsic",
|
| 5307 | "name": "string"
|
| 5308 | }
|
| 5309 | }
|
| 5310 | ],
|
| 5311 | "type": {
|
| 5312 | "type": "reference",
|
| 5313 | "typeArguments": [
|
| 5314 | {
|
| 5315 | "type": "intrinsic",
|
| 5316 | "name": "void"
|
| 5317 | }
|
| 5318 | ],
|
| 5319 | "name": "Promise"
|
| 5320 | }
|
| 5321 | }
|
| 5322 | ]
|
| 5323 | },
|
| 5324 | {
|
| 5325 | "id": 422,
|
| 5326 | "name": "setFieldValue",
|
| 5327 | "kind": 2048,
|
| 5328 | "kindString": "Method",
|
| 5329 | "flags": {},
|
| 5330 | "sources": [
|
| 5331 | {
|
| 5332 | "fileName": "types.ts",
|
| 5333 | "line": 1041,
|
| 5334 | "character": 2
|
| 5335 | }
|
| 5336 | ],
|
| 5337 | "signatures": [
|
| 5338 | {
|
| 5339 | "id": 423,
|
| 5340 | "name": "setFieldValue",
|
| 5341 | "kind": 4096,
|
| 5342 | "kindString": "Call signature",
|
| 5343 | "flags": {},
|
| 5344 | "comment": {
|
| 5345 | "shortText": "Changes a specific path of the `formValues` object",
|
| 5346 | "tags": [
|
| 5347 | {
|
| 5348 | "tag": "example",
|
| 5349 | "text": "\n\n```js\nconst fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');\n```\n"
|
| 5350 | }
|
| 5351 | ]
|
| 5352 | },
|
| 5353 | "parameters": [
|
| 5354 | {
|
| 5355 | "id": 424,
|
| 5356 | "name": "path",
|
| 5357 | "kind": 32768,
|
| 5358 | "kindString": "Parameter",
|
| 5359 | "flags": {},
|
| 5360 | "type": {
|
| 5361 | "type": "intrinsic",
|
| 5362 | "name": "string"
|
| 5363 | }
|
| 5364 | },
|
| 5365 | {
|
| 5366 | "id": 425,
|
| 5367 | "name": "value",
|
| 5368 | "kind": 32768,
|
| 5369 | "kindString": "Parameter",
|
| 5370 | "flags": {},
|
| 5371 | "type": {
|
| 5372 | "type": "intrinsic",
|
| 5373 | "name": "unknown"
|
| 5374 | }
|
| 5375 | }
|
| 5376 | ],
|
| 5377 | "type": {
|
| 5378 | "type": "reference",
|
| 5379 | "typeArguments": [
|
| 5380 | {
|
| 5381 | "type": "intrinsic",
|
| 5382 | "name": "void"
|
| 5383 | }
|
| 5384 | ],
|
| 5385 | "name": "Promise"
|
| 5386 | }
|
| 5387 | }
|
| 5388 | ]
|
| 5389 | },
|
| 5390 | {
|
| 5391 | "id": 410,
|
| 5392 | "name": "toggleField",
|
| 5393 | "kind": 2048,
|
| 5394 | "kindString": "Method",
|
| 5395 | "flags": {},
|
| 5396 | "sources": [
|
| 5397 | {
|
| 5398 | "fileName": "types.ts",
|
| 5399 | "line": 995,
|
| 5400 | "character": 2
|
| 5401 | }
|
| 5402 | ],
|
| 5403 | "signatures": [
|
| 5404 | {
|
| 5405 | "id": 411,
|
| 5406 | "name": "toggleField",
|
| 5407 | "kind": 4096,
|
| 5408 | "kindString": "Call signature",
|
| 5409 | "flags": {},
|
| 5410 | "comment": {
|
| 5411 | "shortText": "Hides/shows a specific field in the form",
|
| 5412 | "tags": [
|
| 5413 | {
|
| 5414 | "tag": "example",
|
| 5415 | "text": "\n\n```js\nconst fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);\n```\n"
|
| 5416 | }
|
| 5417 | ]
|
| 5418 | },
|
| 5419 | "parameters": [
|
| 5420 | {
|
| 5421 | "id": 412,
|
| 5422 | "name": "path",
|
| 5423 | "kind": 32768,
|
| 5424 | "kindString": "Parameter",
|
| 5425 | "flags": {},
|
| 5426 | "type": {
|
| 5427 | "type": "intrinsic",
|
| 5428 | "name": "string"
|
| 5429 | }
|
| 5430 | },
|
| 5431 | {
|
| 5432 | "id": 413,
|
| 5433 | "name": "show",
|
| 5434 | "kind": 32768,
|
| 5435 | "kindString": "Parameter",
|
| 5436 | "flags": {},
|
| 5437 | "type": {
|
| 5438 | "type": "intrinsic",
|
| 5439 | "name": "boolean"
|
| 5440 | }
|
| 5441 | }
|
| 5442 | ],
|
| 5443 | "type": {
|
| 5444 | "type": "reference",
|
| 5445 | "typeArguments": [
|
| 5446 | {
|
| 5447 | "type": "intrinsic",
|
| 5448 | "name": "void"
|
| 5449 | }
|
| 5450 | ],
|
| 5451 | "name": "Promise"
|
| 5452 | }
|
| 5453 | }
|
| 5454 | ]
|
| 5455 | }
|
| 5456 | ],
|
| 5457 | "groups": [
|
| 5458 | {
|
| 5459 | "title": "Methods",
|
| 5460 | "kind": 2048,
|
| 5461 | "children": [
|
| 5462 | 414,
|
| 5463 | 426,
|
| 5464 | 418,
|
| 5465 | 422,
|
| 5466 | 410
|
| 5467 | ]
|
| 5468 | }
|
| 5469 | ],
|
| 5470 | "sources": [
|
| 5471 | {
|
| 5472 | "fileName": "types.ts",
|
| 5473 | "line": 980,
|
| 5474 | "character": 40
|
| 5475 | }
|
| 5476 | ]
|
| 5477 | }
|
| 5478 | }
|
| 5479 | },
|
| 5480 | {
|
| 5481 | "id": 398,
|
| 5482 | "name": "ItemFormAdditionalProperties",
|
| 5483 | "kind": 4194304,
|
| 5484 | "kindString": "Type alias",
|
| 5485 | "flags": {},
|
| 5486 | "comment": {
|
| 5487 | "shortText": "These information describe the current state of the form that's being shown\nto the end-user to edit a record"
|
| 5488 | },
|
| 5489 | "sources": [
|
| 5490 | {
|
| 5491 | "fileName": "types.ts",
|
| 5492 | "line": 956,
|
| 5493 | "character": 12
|
| 5494 | }
|
| 5495 | ],
|
| 5496 | "type": {
|
| 5497 | "type": "reflection",
|
| 5498 | "declaration": {
|
| 5499 | "id": 399,
|
| 5500 | "name": "__type",
|
| 5501 | "kind": 65536,
|
| 5502 | "kindString": "Type literal",
|
| 5503 | "flags": {},
|
| 5504 | "children": [
|
| 5505 | {
|
| 5506 | "id": 403,
|
| 5507 | "name": "formValues",
|
| 5508 | "kind": 1024,
|
| 5509 | "kindString": "Property",
|
| 5510 | "flags": {},
|
| 5511 | "comment": {
|
| 5512 | "shortText": "The complete internal form state"
|
| 5513 | },
|
| 5514 | "sources": [
|
| 5515 | {
|
| 5516 | "fileName": "types.ts",
|
| 5517 | "line": 964,
|
| 5518 | "character": 2
|
| 5519 | }
|
| 5520 | ],
|
| 5521 | "type": {
|
| 5522 | "type": "reference",
|
| 5523 | "typeArguments": [
|
| 5524 | {
|
| 5525 | "type": "intrinsic",
|
| 5526 | "name": "string"
|
| 5527 | },
|
| 5528 | {
|
| 5529 | "type": "intrinsic",
|
| 5530 | "name": "unknown"
|
| 5531 | }
|
| 5532 | ],
|
| 5533 | "name": "Record"
|
| 5534 | }
|
| 5535 | },
|
| 5536 | {
|
| 5537 | "id": 406,
|
| 5538 | "name": "isFormDirty",
|
| 5539 | "kind": 1024,
|
| 5540 | "kindString": "Property",
|
| 5541 | "flags": {},
|
| 5542 | "comment": {
|
| 5543 | "shortText": "Whether the form has some non-persisted changes or not"
|
| 5544 | },
|
| 5545 | "sources": [
|
| 5546 | {
|
| 5547 | "fileName": "types.ts",
|
| 5548 | "line": 970,
|
| 5549 | "character": 2
|
| 5550 | }
|
| 5551 | ],
|
| 5552 | "type": {
|
| 5553 | "type": "intrinsic",
|
| 5554 | "name": "boolean"
|
| 5555 | }
|
| 5556 | },
|
| 5557 | {
|
| 5558 | "id": 405,
|
| 5559 | "name": "isSubmitting",
|
| 5560 | "kind": 1024,
|
| 5561 | "kindString": "Property",
|
| 5562 | "flags": {},
|
| 5563 | "comment": {
|
| 5564 | "shortText": "Whether the form is currently submitting itself or not"
|
| 5565 | },
|
| 5566 | "sources": [
|
| 5567 | {
|
| 5568 | "fileName": "types.ts",
|
| 5569 | "line": 968,
|
| 5570 | "character": 2
|
| 5571 | }
|
| 5572 | ],
|
| 5573 | "type": {
|
| 5574 | "type": "intrinsic",
|
| 5575 | "name": "boolean"
|
| 5576 | }
|
| 5577 | },
|
| 5578 | {
|
| 5579 | "id": 401,
|
| 5580 | "name": "item",
|
| 5581 | "kind": 1024,
|
| 5582 | "kindString": "Property",
|
| 5583 | "flags": {},
|
| 5584 | "comment": {
|
| 5585 | "shortText": "If an already persisted record is being edited, returns the full record entity"
|
| 5586 | },
|
| 5587 | "sources": [
|
| 5588 | {
|
| 5589 | "fileName": "types.ts",
|
| 5590 | "line": 960,
|
| 5591 | "character": 2
|
| 5592 | }
|
| 5593 | ],
|
| 5594 | "type": {
|
| 5595 | "type": "union",
|
| 5596 | "types": [
|
| 5597 | {
|
| 5598 | "type": "reference",
|
| 5599 | "id": 10,
|
| 5600 | "name": "Item"
|
| 5601 | },
|
| 5602 | {
|
| 5603 | "type": "literal",
|
| 5604 | "value": null
|
| 5605 | }
|
| 5606 | ]
|
| 5607 | }
|
| 5608 | },
|
| 5609 | {
|
| 5610 | "id": 404,
|
| 5611 | "name": "itemStatus",
|
| 5612 | "kind": 1024,
|
| 5613 | "kindString": "Property",
|
| 5614 | "flags": {},
|
| 5615 | "comment": {
|
| 5616 | "shortText": "The current status of the record being edited"
|
| 5617 | },
|
| 5618 | "sources": [
|
| 5619 | {
|
| 5620 | "fileName": "types.ts",
|
| 5621 | "line": 966,
|
| 5622 | "character": 2
|
| 5623 | }
|
| 5624 | ],
|
| 5625 | "type": {
|
| 5626 | "type": "union",
|
| 5627 | "types": [
|
| 5628 | {
|
| 5629 | "type": "literal",
|
| 5630 | "value": "new"
|
| 5631 | },
|
| 5632 | {
|
| 5633 | "type": "literal",
|
| 5634 | "value": "draft"
|
| 5635 | },
|
| 5636 | {
|
| 5637 | "type": "literal",
|
| 5638 | "value": "updated"
|
| 5639 | },
|
| 5640 | {
|
| 5641 | "type": "literal",
|
| 5642 | "value": "published"
|
| 5643 | }
|
| 5644 | ]
|
| 5645 | }
|
| 5646 | },
|
| 5647 | {
|
| 5648 | "id": 402,
|
| 5649 | "name": "itemType",
|
| 5650 | "kind": 1024,
|
| 5651 | "kindString": "Property",
|
| 5652 | "flags": {},
|
| 5653 | "comment": {
|
| 5654 | "shortText": "The model for the record being edited"
|
| 5655 | },
|
| 5656 | "sources": [
|
| 5657 | {
|
| 5658 | "fileName": "types.ts",
|
| 5659 | "line": 962,
|
| 5660 | "character": 2
|
| 5661 | }
|
| 5662 | ],
|
| 5663 | "type": {
|
| 5664 | "type": "reference",
|
| 5665 | "id": 16,
|
| 5666 | "name": "ModelBlock"
|
| 5667 | }
|
| 5668 | },
|
| 5669 | {
|
| 5670 | "id": 400,
|
| 5671 | "name": "locale",
|
| 5672 | "kind": 1024,
|
| 5673 | "kindString": "Property",
|
| 5674 | "flags": {},
|
| 5675 | "comment": {
|
| 5676 | "shortText": "The currently active locale for the record"
|
| 5677 | },
|
| 5678 | "sources": [
|
| 5679 | {
|
| 5680 | "fileName": "types.ts",
|
| 5681 | "line": 958,
|
| 5682 | "character": 2
|
| 5683 | }
|
| 5684 | ],
|
| 5685 | "type": {
|
| 5686 | "type": "intrinsic",
|
| 5687 | "name": "string"
|
| 5688 | }
|
| 5689 | }
|
| 5690 | ],
|
| 5691 | "groups": [
|
| 5692 | {
|
| 5693 | "title": "Properties",
|
| 5694 | "kind": 1024,
|
| 5695 | "children": [
|
| 5696 | 403,
|
| 5697 | 406,
|
| 5698 | 405,
|
| 5699 | 401,
|
| 5700 | 404,
|
| 5701 | 402,
|
| 5702 | 400
|
| 5703 | ]
|
| 5704 | }
|
| 5705 | ],
|
| 5706 | "sources": [
|
| 5707 | {
|
| 5708 | "fileName": "types.ts",
|
| 5709 | "line": 956,
|
| 5710 | "character": 43
|
| 5711 | }
|
| 5712 | ]
|
| 5713 | }
|
| 5714 | }
|
| 5715 | },
|
| 5716 | {
|
| 5717 | "id": 428,
|
| 5718 | "name": "ItemFormMethods",
|
| 5719 | "kind": 4194304,
|
| 5720 | "kindString": "Type alias",
|
| 5721 | "flags": {},
|
| 5722 | "sources": [
|
| 5723 | {
|
| 5724 | "fileName": "types.ts",
|
| 5725 | "line": 1054,
|
| 5726 | "character": 12
|
| 5727 | }
|
| 5728 | ],
|
| 5729 | "type": {
|
| 5730 | "type": "intersection",
|
| 5731 | "types": [
|
| 5732 | {
|
| 5733 | "type": "reference",
|
| 5734 | "id": 397,
|
| 5735 | "name": "RenderMethods"
|
| 5736 | },
|
| 5737 | {
|
| 5738 | "type": "reference",
|
| 5739 | "id": 392,
|
| 5740 | "name": "IframeMethods"
|
| 5741 | },
|
| 5742 | {
|
| 5743 | "type": "reference",
|
| 5744 | "id": 408,
|
| 5745 | "name": "ItemFormAdditionalMethods"
|
| 5746 | }
|
| 5747 | ]
|
| 5748 | }
|
| 5749 | },
|
| 5750 | {
|
| 5751 | "id": 407,
|
| 5752 | "name": "ItemFormProperties",
|
| 5753 | "kind": 4194304,
|
| 5754 | "kindString": "Type alias",
|
| 5755 | "flags": {},
|
| 5756 | "sources": [
|
| 5757 | {
|
| 5758 | "fileName": "types.ts",
|
| 5759 | "line": 973,
|
| 5760 | "character": 12
|
| 5761 | }
|
| 5762 | ],
|
| 5763 | "type": {
|
| 5764 | "type": "intersection",
|
| 5765 | "types": [
|
| 5766 | {
|
| 5767 | "type": "reference",
|
| 5768 | "id": 281,
|
| 5769 | "name": "RenderProperties"
|
| 5770 | },
|
| 5771 | {
|
| 5772 | "type": "reference",
|
| 5773 | "id": 398,
|
| 5774 | "name": "ItemFormAdditionalProperties"
|
| 5775 | }
|
| 5776 | ]
|
| 5777 | }
|
| 5778 | },
|
| 5779 | {
|
| 5780 | "id": 175,
|
| 5781 | "name": "ItemFormSidebarPanel",
|
| 5782 | "kind": 4194304,
|
| 5783 | "kindString": "Type alias",
|
| 5784 | "flags": {},
|
| 5785 | "comment": {
|
| 5786 | "shortText": "A sidebar panel to be shown inside the record's editing page"
|
| 5787 | },
|
| 5788 | "sources": [
|
| 5789 | {
|
| 5790 | "fileName": "types.ts",
|
| 5791 | "line": 203,
|
| 5792 | "character": 12
|
| 5793 | }
|
| 5794 | ],
|
| 5795 | "type": {
|
| 5796 | "type": "reflection",
|
| 5797 | "declaration": {
|
| 5798 | "id": 176,
|
| 5799 | "name": "__type",
|
| 5800 | "kind": 65536,
|
| 5801 | "kindString": "Type literal",
|
| 5802 | "flags": {},
|
| 5803 | "children": [
|
| 5804 | {
|
| 5805 | "id": 177,
|
| 5806 | "name": "id",
|
| 5807 | "kind": 1024,
|
| 5808 | "kindString": "Property",
|
| 5809 | "flags": {},
|
| 5810 | "comment": {
|
| 5811 | "shortText": "ID of the panel. Will be the first argument for the\n`renderItemFormSidebarPanel` function"
|
| 5812 | },
|
| 5813 | "sources": [
|
| 5814 | {
|
| 5815 | "fileName": "types.ts",
|
| 5816 | "line": 208,
|
| 5817 | "character": 2
|
| 5818 | }
|
| 5819 | ],
|
| 5820 | "type": {
|
| 5821 | "type": "intrinsic",
|
| 5822 | "name": "string"
|
| 5823 | }
|
| 5824 | },
|
| 5825 | {
|
| 5826 | "id": 183,
|
| 5827 | "name": "initialHeight",
|
| 5828 | "kind": 1024,
|
| 5829 | "kindString": "Property",
|
| 5830 | "flags": {
|
| 5831 | "isOptional": true
|
| 5832 | },
|
| 5833 | "comment": {
|
| 5834 | "shortText": "The initial height to set for the iframe that will render the sidebar panel"
|
| 5835 | },
|
| 5836 | "sources": [
|
| 5837 | {
|
| 5838 | "fileName": "types.ts",
|
| 5839 | "line": 233,
|
| 5840 | "character": 2
|
| 5841 | }
|
| 5842 | ],
|
| 5843 | "type": {
|
| 5844 | "type": "intrinsic",
|
| 5845 | "name": "number"
|
| 5846 | }
|
| 5847 | },
|
| 5848 | {
|
| 5849 | "id": 178,
|
| 5850 | "name": "label",
|
| 5851 | "kind": 1024,
|
| 5852 | "kindString": "Property",
|
| 5853 | "flags": {},
|
| 5854 | "comment": {
|
| 5855 | "shortText": "Label to be shown on the collapsible sidebar panel handle"
|
| 5856 | },
|
| 5857 | "sources": [
|
| 5858 | {
|
| 5859 | "fileName": "types.ts",
|
| 5860 | "line": 210,
|
| 5861 | "character": 2
|
| 5862 | }
|
| 5863 | ],
|
| 5864 | "type": {
|
| 5865 | "type": "intrinsic",
|
| 5866 | "name": "string"
|
| 5867 | }
|
| 5868 | },
|
| 5869 | {
|
| 5870 | "id": 179,
|
| 5871 | "name": "parameters",
|
| 5872 | "kind": 1024,
|
| 5873 | "kindString": "Property",
|
| 5874 | "flags": {
|
| 5875 | "isOptional": true
|
| 5876 | },
|
| 5877 | "comment": {
|
| 5878 | "shortText": "An arbitrary configuration object that will be passed as the `parameters`\nproperty of the second argument of the `renderItemFormSidebarPanel` function"
|
| 5879 | },
|
| 5880 | "sources": [
|
| 5881 | {
|
| 5882 | "fileName": "types.ts",
|
| 5883 | "line": 215,
|
| 5884 | "character": 2
|
| 5885 | }
|
| 5886 | ],
|
| 5887 | "type": {
|
| 5888 | "type": "reference",
|
| 5889 | "typeArguments": [
|
| 5890 | {
|
| 5891 | "type": "intrinsic",
|
| 5892 | "name": "string"
|
| 5893 | },
|
| 5894 | {
|
| 5895 | "type": "intrinsic",
|
| 5896 | "name": "unknown"
|
| 5897 | }
|
| 5898 | ],
|
| 5899 | "name": "Record"
|
| 5900 | }
|
| 5901 | },
|
| 5902 | {
|
| 5903 | "id": 181,
|
| 5904 | "name": "placement",
|
| 5905 | "kind": 1024,
|
| 5906 | "kindString": "Property",
|
| 5907 | "flags": {
|
| 5908 | "isOptional": true
|
| 5909 | },
|
| 5910 | "comment": {
|
| 5911 | "shortText": "Expresses where you want the item to be placed inside the sidebar. If not\nspecified, the item will be placed after the standard panels provided by\nDatoCMS itself."
|
| 5912 | },
|
| 5913 | "sources": [
|
| 5914 | {
|
| 5915 | "fileName": "types.ts",
|
| 5916 | "line": 223,
|
| 5917 | "character": 2
|
| 5918 | }
|
| 5919 | ],
|
| 5920 | "type": {
|
| 5921 | "type": "reference",
|
| 5922 | "id": 174,
|
| 5923 | "name": "ItemFormSidebarPanelPlacement"
|
| 5924 | }
|
| 5925 | },
|
| 5926 | {
|
| 5927 | "id": 182,
|
| 5928 | "name": "rank",
|
| 5929 | "kind": 1024,
|
| 5930 | "kindString": "Property",
|
| 5931 | "flags": {
|
| 5932 | "isOptional": true
|
| 5933 | },
|
| 5934 | "comment": {
|
| 5935 | "shortText": "If multiple sidebar panels specify the same `placement`, they will be\nsorted by ascending `rank`. If you want to specify an explicit value for\n`rank`, make sure to offer a way for final users to customize it inside the\nplugin's settings form, otherwise the hardcoded value you choose might\nclash with the one of another plugin! *"
|
| 5936 | },
|
| 5937 | "sources": [
|
| 5938 | {
|
| 5939 | "fileName": "types.ts",
|
| 5940 | "line": 231,
|
| 5941 | "character": 2
|
| 5942 | }
|
| 5943 | ],
|
| 5944 | "type": {
|
| 5945 | "type": "intrinsic",
|
| 5946 | "name": "number"
|
| 5947 | }
|
| 5948 | },
|
| 5949 | {
|
| 5950 | "id": 180,
|
| 5951 | "name": "startOpen",
|
| 5952 | "kind": 1024,
|
| 5953 | "kindString": "Property",
|
| 5954 | "flags": {
|
| 5955 | "isOptional": true
|
| 5956 | },
|
| 5957 | "comment": {
|
| 5958 | "shortText": "Whether the sidebar panel will start open or collapsed"
|
| 5959 | },
|
| 5960 | "sources": [
|
| 5961 | {
|
| 5962 | "fileName": "types.ts",
|
| 5963 | "line": 217,
|
| 5964 | "character": 2
|
| 5965 | }
|
| 5966 | ],
|
| 5967 | "type": {
|
| 5968 | "type": "intrinsic",
|
| 5969 | "name": "boolean"
|
| 5970 | }
|
| 5971 | }
|
| 5972 | ],
|
| 5973 | "groups": [
|
| 5974 | {
|
| 5975 | "title": "Properties",
|
| 5976 | "kind": 1024,
|
| 5977 | "children": [
|
| 5978 | 177,
|
| 5979 | 183,
|
| 5980 | 178,
|
| 5981 | 179,
|
| 5982 | 181,
|
| 5983 | 182,
|
| 5984 | 180
|
| 5985 | ]
|
| 5986 | }
|
| 5987 | ],
|
| 5988 | "sources": [
|
| 5989 | {
|
| 5990 | "fileName": "types.ts",
|
| 5991 | "line": 203,
|
| 5992 | "character": 35
|
| 5993 | }
|
| 5994 | ]
|
| 5995 | }
|
| 5996 | }
|
| 5997 | },
|
| 5998 | {
|
| 5999 | "id": 174,
|
| 6000 | "name": "ItemFormSidebarPanelPlacement",
|
| 6001 | "kind": 4194304,
|
| 6002 | "kindString": "Type alias",
|
| 6003 | "flags": {},
|
| 6004 | "sources": [
|
| 6005 | {
|
| 6006 | "fileName": "types.ts",
|
| 6007 | "line": 197,
|
| 6008 | "character": 12
|
| 6009 | }
|
| 6010 | ],
|
| 6011 | "type": {
|
| 6012 | "type": "tuple",
|
| 6013 | "elements": [
|
| 6014 | {
|
| 6015 | "type": "union",
|
| 6016 | "types": [
|
| 6017 | {
|
| 6018 | "type": "literal",
|
| 6019 | "value": "before"
|
| 6020 | },
|
| 6021 | {
|
| 6022 | "type": "literal",
|
| 6023 | "value": "after"
|
| 6024 | }
|
| 6025 | ]
|
| 6026 | },
|
| 6027 | {
|
| 6028 | "type": "union",
|
| 6029 | "types": [
|
| 6030 | {
|
| 6031 | "type": "literal",
|
| 6032 | "value": "info"
|
| 6033 | },
|
| 6034 | {
|
| 6035 | "type": "literal",
|
| 6036 | "value": "actions"
|
| 6037 | },
|
| 6038 | {
|
| 6039 | "type": "literal",
|
| 6040 | "value": "links"
|
| 6041 | },
|
| 6042 | {
|
| 6043 | "type": "literal",
|
| 6044 | "value": "history"
|
| 6045 | }
|
| 6046 | ]
|
| 6047 | }
|
| 6048 | ]
|
| 6049 | }
|
| 6050 | },
|
| 6051 | {
|
| 6052 | "id": 315,
|
| 6053 | "name": "LoadDataMethods",
|
| 6054 | "kind": 4194304,
|
| 6055 | "kindString": "Type alias",
|
| 6056 | "flags": {},
|
| 6057 | "comment": {
|
| 6058 | "shortText": "These methods can be used to asyncronously load additional information your\nplugin needs to work"
|
| 6059 | },
|
| 6060 | "sources": [
|
| 6061 | {
|
| 6062 | "fileName": "types.ts",
|
| 6063 | "line": 586,
|
| 6064 | "character": 12
|
| 6065 | }
|
| 6066 | ],
|
| 6067 | "type": {
|
| 6068 | "type": "reflection",
|
| 6069 | "declaration": {
|
| 6070 | "id": 316,
|
| 6071 | "name": "__type",
|
| 6072 | "kind": 65536,
|
| 6073 | "kindString": "Type literal",
|
| 6074 | "flags": {},
|
| 6075 | "children": [
|
| 6076 | {
|
| 6077 | "id": 320,
|
| 6078 | "name": "loadFieldsUsingPlugin",
|
| 6079 | "kind": 2048,
|
| 6080 | "kindString": "Method",
|
| 6081 | "flags": {},
|
| 6082 | "sources": [
|
| 6083 | {
|
| 6084 | "fileName": "types.ts",
|
| 6085 | "line": 622,
|
| 6086 | "character": 2
|
| 6087 | }
|
| 6088 | ],
|
| 6089 | "signatures": [
|
| 6090 | {
|
| 6091 | "id": 321,
|
| 6092 | "name": "loadFieldsUsingPlugin",
|
| 6093 | "kind": 4096,
|
| 6094 | "kindString": "Call signature",
|
| 6095 | "flags": {},
|
| 6096 | "comment": {
|
| 6097 | "shortText": "Loads all the fields in the project that are currently using the plugin for\none of its manual field extensions.",
|
| 6098 | "tags": [
|
| 6099 | {
|
| 6100 | "tag": "example",
|
| 6101 | "text": "\n\n```js\nconst fields = await ctx.loadFieldsUsingPlugin();\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);\n```\n"
|
| 6102 | }
|
| 6103 | ]
|
| 6104 | },
|
| 6105 | "type": {
|
| 6106 | "type": "reference",
|
| 6107 | "typeArguments": [
|
| 6108 | {
|
| 6109 | "type": "array",
|
| 6110 | "elementType": {
|
| 6111 | "type": "reference",
|
| 6112 | "id": 5,
|
| 6113 | "name": "Field"
|
| 6114 | }
|
| 6115 | }
|
| 6116 | ],
|
| 6117 | "name": "Promise"
|
| 6118 | }
|
| 6119 | }
|
| 6120 | ]
|
| 6121 | },
|
| 6122 | {
|
| 6123 | "id": 317,
|
| 6124 | "name": "loadItemTypeFields",
|
| 6125 | "kind": 2048,
|
| 6126 | "kindString": "Method",
|
| 6127 | "flags": {},
|
| 6128 | "sources": [
|
| 6129 | {
|
| 6130 | "fileName": "types.ts",
|
| 6131 | "line": 605,
|
| 6132 | "character": 2
|
| 6133 | }
|
| 6134 | ],
|
| 6135 | "signatures": [
|
| 6136 | {
|
| 6137 | "id": 318,
|
| 6138 | "name": "loadItemTypeFields",
|
| 6139 | "kind": 4096,
|
| 6140 | "kindString": "Call signature",
|
| 6141 | "flags": {},
|
| 6142 | "comment": {
|
| 6143 | "shortText": "Loads all the fields for a specific model (or block). Fields will be\nreturned and will also be available in the the `fields` property.",
|
| 6144 | "tags": [
|
| 6145 | {
|
| 6146 | "tag": "example",
|
| 6147 | "text": "\n\n```js\nconst itemTypeId = prompt('Please insert a model ID:');\n\nconst fields = await ctx.loadItemTypeFields(itemTypeId);\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);\n```\n"
|
| 6148 | }
|
| 6149 | ]
|
| 6150 | },
|
| 6151 | "parameters": [
|
| 6152 | {
|
| 6153 | "id": 319,
|
| 6154 | "name": "itemTypeId",
|
| 6155 | "kind": 32768,
|
| 6156 | "kindString": "Parameter",
|
| 6157 | "flags": {},
|
| 6158 | "type": {
|
| 6159 | "type": "intrinsic",
|
| 6160 | "name": "string"
|
| 6161 | }
|
| 6162 | }
|
| 6163 | ],
|
| 6164 | "type": {
|
| 6165 | "type": "reference",
|
| 6166 | "typeArguments": [
|
| 6167 | {
|
| 6168 | "type": "array",
|
| 6169 | "elementType": {
|
| 6170 | "type": "reference",
|
| 6171 | "id": 5,
|
| 6172 | "name": "Field"
|
| 6173 | }
|
| 6174 | }
|
| 6175 | ],
|
| 6176 | "name": "Promise"
|
| 6177 | }
|
| 6178 | }
|
| 6179 | ]
|
| 6180 | },
|
| 6181 | {
|
| 6182 | "id": 324,
|
| 6183 | "name": "loadSsoUsers",
|
| 6184 | "kind": 2048,
|
| 6185 | "kindString": "Method",
|
| 6186 | "flags": {},
|
| 6187 | "sources": [
|
| 6188 | {
|
| 6189 | "fileName": "types.ts",
|
| 6190 | "line": 648,
|
| 6191 | "character": 2
|
| 6192 | }
|
| 6193 | ],
|
| 6194 | "signatures": [
|
| 6195 | {
|
| 6196 | "id": 325,
|
| 6197 | "name": "loadSsoUsers",
|
| 6198 | "kind": 4096,
|
| 6199 | "kindString": "Call signature",
|
| 6200 | "flags": {},
|
| 6201 | "comment": {
|
| 6202 | "shortText": "Loads all SSO users. Users will be returned and will also be available in\nthe the `ssoUsers` property.",
|
| 6203 | "tags": [
|
| 6204 | {
|
| 6205 | "tag": "example",
|
| 6206 | "text": "\n\n```js\nconst users = await ctx.loadSsoUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);\n```\n"
|
| 6207 | }
|
| 6208 | ]
|
| 6209 | },
|
| 6210 | "type": {
|
| 6211 | "type": "reference",
|
| 6212 | "typeArguments": [
|
| 6213 | {
|
| 6214 | "type": "array",
|
| 6215 | "elementType": {
|
| 6216 | "type": "reference",
|
| 6217 | "id": 31,
|
| 6218 | "name": "SsoUser"
|
| 6219 | }
|
| 6220 | }
|
| 6221 | ],
|
| 6222 | "name": "Promise"
|
| 6223 | }
|
| 6224 | }
|
| 6225 | ]
|
| 6226 | },
|
| 6227 | {
|
| 6228 | "id": 322,
|
| 6229 | "name": "loadUsers",
|
| 6230 | "kind": 2048,
|
| 6231 | "kindString": "Method",
|
| 6232 | "flags": {},
|
| 6233 | "sources": [
|
| 6234 | {
|
| 6235 | "fileName": "types.ts",
|
| 6236 | "line": 635,
|
| 6237 | "character": 2
|
| 6238 | }
|
| 6239 | ],
|
| 6240 | "signatures": [
|
| 6241 | {
|
| 6242 | "id": 323,
|
| 6243 | "name": "loadUsers",
|
| 6244 | "kind": 4096,
|
| 6245 | "kindString": "Call signature",
|
| 6246 | "flags": {},
|
| 6247 | "comment": {
|
| 6248 | "shortText": "Loads all regular users. Users will be returned and will also be available\nin the the `users` property.",
|
| 6249 | "tags": [
|
| 6250 | {
|
| 6251 | "tag": "example",
|
| 6252 | "text": "\n\n```js\nconst users = await ctx.loadUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);\n```\n"
|
| 6253 | }
|
| 6254 | ]
|
| 6255 | },
|
| 6256 | "type": {
|
| 6257 | "type": "reference",
|
| 6258 | "typeArguments": [
|
| 6259 | {
|
| 6260 | "type": "array",
|
| 6261 | "elementType": {
|
| 6262 | "type": "reference",
|
| 6263 | "id": 42,
|
| 6264 | "name": "User"
|
| 6265 | }
|
| 6266 | }
|
| 6267 | ],
|
| 6268 | "name": "Promise"
|
| 6269 | }
|
| 6270 | }
|
| 6271 | ]
|
| 6272 | }
|
| 6273 | ],
|
| 6274 | "groups": [
|
| 6275 | {
|
| 6276 | "title": "Methods",
|
| 6277 | "kind": 2048,
|
| 6278 | "children": [
|
| 6279 | 320,
|
| 6280 | 317,
|
| 6281 | 324,
|
| 6282 | 322
|
| 6283 | ]
|
| 6284 | }
|
| 6285 | ],
|
| 6286 | "sources": [
|
| 6287 | {
|
| 6288 | "fileName": "types.ts",
|
| 6289 | "line": 586,
|
| 6290 | "character": 30
|
| 6291 | }
|
| 6292 | ]
|
| 6293 | }
|
| 6294 | }
|
| 6295 | },
|
| 6296 | {
|
| 6297 | "id": 129,
|
| 6298 | "name": "MainNavigationTab",
|
| 6299 | "kind": 4194304,
|
| 6300 | "kindString": "Type alias",
|
| 6301 | "flags": {},
|
| 6302 | "comment": {
|
| 6303 | "shortText": "A tab to be displayed in the top-bar of the UI"
|
| 6304 | },
|
| 6305 | "sources": [
|
| 6306 | {
|
| 6307 | "fileName": "types.ts",
|
| 6308 | "line": 28,
|
| 6309 | "character": 12
|
| 6310 | }
|
| 6311 | ],
|
| 6312 | "type": {
|
| 6313 | "type": "reflection",
|
| 6314 | "declaration": {
|
| 6315 | "id": 130,
|
| 6316 | "name": "__type",
|
| 6317 | "kind": 65536,
|
| 6318 | "kindString": "Type literal",
|
| 6319 | "flags": {},
|
| 6320 | "children": [
|
| 6321 | {
|
| 6322 | "id": 132,
|
| 6323 | "name": "icon",
|
| 6324 | "kind": 1024,
|
| 6325 | "kindString": "Property",
|
| 6326 | "flags": {},
|
| 6327 | "comment": {
|
| 6328 | "shortText": "FontAwesome icon name to be shown alongside the label"
|
| 6329 | },
|
| 6330 | "sources": [
|
| 6331 | {
|
| 6332 | "fileName": "types.ts",
|
| 6333 | "line": 32,
|
| 6334 | "character": 2
|
| 6335 | }
|
| 6336 | ],
|
| 6337 | "type": {
|
| 6338 | "type": "intrinsic",
|
| 6339 | "name": "string"
|
| 6340 | }
|
| 6341 | },
|
| 6342 | {
|
| 6343 | "id": 131,
|
| 6344 | "name": "label",
|
| 6345 | "kind": 1024,
|
| 6346 | "kindString": "Property",
|
| 6347 | "flags": {},
|
| 6348 | "comment": {
|
| 6349 | "shortText": "Label to be shown. Must be unique."
|
| 6350 | },
|
| 6351 | "sources": [
|
| 6352 | {
|
| 6353 | "fileName": "types.ts",
|
| 6354 | "line": 30,
|
| 6355 | "character": 2
|
| 6356 | }
|
| 6357 | ],
|
| 6358 | "type": {
|
| 6359 | "type": "intrinsic",
|
| 6360 | "name": "string"
|
| 6361 | }
|
| 6362 | },
|
| 6363 | {
|
| 6364 | "id": 136,
|
| 6365 | "name": "placement",
|
| 6366 | "kind": 1024,
|
| 6367 | "kindString": "Property",
|
| 6368 | "flags": {
|
| 6369 | "isOptional": true
|
| 6370 | },
|
| 6371 | "comment": {
|
| 6372 | "shortText": "Expresses where you want to place the tab in the top-bar. If not specified,\nthe tab will be placed after the standard tabs provided by DatoCMS itself."
|
| 6373 | },
|
| 6374 | "sources": [
|
| 6375 | {
|
| 6376 | "fileName": "types.ts",
|
| 6377 | "line": 41,
|
| 6378 | "character": 2
|
| 6379 | }
|
| 6380 | ],
|
| 6381 | "type": {
|
| 6382 | "type": "tuple",
|
| 6383 | "elements": [
|
| 6384 | {
|
| 6385 | "type": "union",
|
| 6386 | "types": [
|
| 6387 | {
|
| 6388 | "type": "literal",
|
| 6389 | "value": "before"
|
| 6390 | },
|
| 6391 | {
|
| 6392 | "type": "literal",
|
| 6393 | "value": "after"
|
| 6394 | }
|
| 6395 | ]
|
| 6396 | },
|
| 6397 | {
|
| 6398 | "type": "union",
|
| 6399 | "types": [
|
| 6400 | {
|
| 6401 | "type": "literal",
|
| 6402 | "value": "content"
|
| 6403 | },
|
| 6404 | {
|
| 6405 | "type": "literal",
|
| 6406 | "value": "mediaArea"
|
| 6407 | },
|
| 6408 | {
|
| 6409 | "type": "literal",
|
| 6410 | "value": "apiExplorer"
|
| 6411 | },
|
| 6412 | {
|
| 6413 | "type": "literal",
|
| 6414 | "value": "settings"
|
| 6415 | }
|
| 6416 | ]
|
| 6417 | }
|
| 6418 | ]
|
| 6419 | }
|
| 6420 | },
|
| 6421 | {
|
| 6422 | "id": 133,
|
| 6423 | "name": "pointsTo",
|
| 6424 | "kind": 1024,
|
| 6425 | "kindString": "Property",
|
| 6426 | "flags": {},
|
| 6427 | "comment": {
|
| 6428 | "shortText": "ID of the page linked to the tab"
|
| 6429 | },
|
| 6430 | "sources": [
|
| 6431 | {
|
| 6432 | "fileName": "types.ts",
|
| 6433 | "line": 34,
|
| 6434 | "character": 2
|
| 6435 | }
|
| 6436 | ],
|
| 6437 | "type": {
|
| 6438 | "type": "reflection",
|
| 6439 | "declaration": {
|
| 6440 | "id": 134,
|
| 6441 | "name": "__type",
|
| 6442 | "kind": 65536,
|
| 6443 | "kindString": "Type literal",
|
| 6444 | "flags": {},
|
| 6445 | "children": [
|
| 6446 | {
|
| 6447 | "id": 135,
|
| 6448 | "name": "pageId",
|
| 6449 | "kind": 1024,
|
| 6450 | "kindString": "Property",
|
| 6451 | "flags": {},
|
| 6452 | "sources": [
|
| 6453 | {
|
| 6454 | "fileName": "types.ts",
|
| 6455 | "line": 35,
|
| 6456 | "character": 4
|
| 6457 | }
|
| 6458 | ],
|
| 6459 | "type": {
|
| 6460 | "type": "intrinsic",
|
| 6461 | "name": "string"
|
| 6462 | }
|
| 6463 | }
|
| 6464 | ],
|
| 6465 | "groups": [
|
| 6466 | {
|
| 6467 | "title": "Properties",
|
| 6468 | "kind": 1024,
|
| 6469 | "children": [
|
| 6470 | 135
|
| 6471 | ]
|
| 6472 | }
|
| 6473 | ],
|
| 6474 | "sources": [
|
| 6475 | {
|
| 6476 | "fileName": "types.ts",
|
| 6477 | "line": 34,
|
| 6478 | "character": 12
|
| 6479 | }
|
| 6480 | ]
|
| 6481 | }
|
| 6482 | }
|
| 6483 | },
|
| 6484 | {
|
| 6485 | "id": 137,
|
| 6486 | "name": "rank",
|
| 6487 | "kind": 1024,
|
| 6488 | "kindString": "Property",
|
| 6489 | "flags": {
|
| 6490 | "isOptional": true
|
| 6491 | },
|
| 6492 | "comment": {
|
| 6493 | "shortText": "If different plugins specify the same `placement` for their tabs, they will\nbe displayed by ascending `rank`. If you want to specify an explicit value\nfor `rank`, make sure to offer a way for final users to customize it inside\nthe plugin's settings form, otherwise the hardcoded value you choose might\nclash with the one of another plugin! *"
|
| 6494 | },
|
| 6495 | "sources": [
|
| 6496 | {
|
| 6497 | "fileName": "types.ts",
|
| 6498 | "line": 52,
|
| 6499 | "character": 2
|
| 6500 | }
|
| 6501 | ],
|
| 6502 | "type": {
|
| 6503 | "type": "intrinsic",
|
| 6504 | "name": "number"
|
| 6505 | }
|
| 6506 | }
|
| 6507 | ],
|
| 6508 | "groups": [
|
| 6509 | {
|
| 6510 | "title": "Properties",
|
| 6511 | "kind": 1024,
|
| 6512 | "children": [
|
| 6513 | 132,
|
| 6514 | 131,
|
| 6515 | 136,
|
| 6516 | 133,
|
| 6517 | 137
|
| 6518 | ]
|
| 6519 | }
|
| 6520 | ],
|
| 6521 | "sources": [
|
| 6522 | {
|
| 6523 | "fileName": "types.ts",
|
| 6524 | "line": 28,
|
| 6525 | "character": 32
|
| 6526 | }
|
| 6527 | ]
|
| 6528 | }
|
| 6529 | }
|
| 6530 | },
|
| 6531 | {
|
| 6532 | "id": 161,
|
| 6533 | "name": "ManualFieldExtension",
|
| 6534 | "kind": 4194304,
|
| 6535 | "kindString": "Type alias",
|
| 6536 | "flags": {},
|
| 6537 | "comment": {
|
| 6538 | "shortText": "Field extensions extend the basic functionality of DatoCMS when it comes to\npresenting record's fields to the final user. Depending on the extension type\n(`editor` or `addon`) they will be shown in different places of the interface."
|
| 6539 | },
|
| 6540 | "sources": [
|
| 6541 | {
|
| 6542 | "fileName": "types.ts",
|
| 6543 | "line": 164,
|
| 6544 | "character": 12
|
| 6545 | }
|
| 6546 | ],
|
| 6547 | "type": {
|
| 6548 | "type": "reflection",
|
| 6549 | "declaration": {
|
| 6550 | "id": 162,
|
| 6551 | "name": "__type",
|
| 6552 | "kind": 65536,
|
| 6553 | "kindString": "Type literal",
|
| 6554 | "flags": {},
|
| 6555 | "children": [
|
| 6556 | {
|
| 6557 | "id": 166,
|
| 6558 | "name": "asSidebarPanel",
|
| 6559 | "kind": 1024,
|
| 6560 | "kindString": "Property",
|
| 6561 | "flags": {
|
| 6562 | "isOptional": true
|
| 6563 | },
|
| 6564 | "comment": {
|
| 6565 | "shortText": "For `editor` extensions: moves the field to the sidebar of the record\nediting page, mimicking a sidebar panel"
|
| 6566 | },
|
| 6567 | "sources": [
|
| 6568 | {
|
| 6569 | "fileName": "types.ts",
|
| 6570 | "line": 183,
|
| 6571 | "character": 2
|
| 6572 | }
|
| 6573 | ],
|
| 6574 | "type": {
|
| 6575 | "type": "union",
|
| 6576 | "types": [
|
| 6577 | {
|
| 6578 | "type": "intrinsic",
|
| 6579 | "name": "boolean"
|
| 6580 | },
|
| 6581 | {
|
| 6582 | "type": "reflection",
|
| 6583 | "declaration": {
|
| 6584 | "id": 167,
|
| 6585 | "name": "__type",
|
| 6586 | "kind": 65536,
|
| 6587 | "kindString": "Type literal",
|
| 6588 | "flags": {},
|
| 6589 | "children": [
|
| 6590 | {
|
| 6591 | "id": 168,
|
| 6592 | "name": "startOpen",
|
| 6593 | "kind": 1024,
|
| 6594 | "kindString": "Property",
|
| 6595 | "flags": {},
|
| 6596 | "sources": [
|
| 6597 | {
|
| 6598 | "fileName": "types.ts",
|
| 6599 | "line": 183,
|
| 6600 | "character": 31
|
| 6601 | }
|
| 6602 | ],
|
| 6603 | "type": {
|
| 6604 | "type": "intrinsic",
|
| 6605 | "name": "boolean"
|
| 6606 | }
|
| 6607 | }
|
| 6608 | ],
|
| 6609 | "groups": [
|
| 6610 | {
|
| 6611 | "title": "Properties",
|
| 6612 | "kind": 1024,
|
| 6613 | "children": [
|
| 6614 | 168
|
| 6615 | ]
|
| 6616 | }
|
| 6617 | ],
|
| 6618 | "sources": [
|
| 6619 | {
|
| 6620 | "fileName": "types.ts",
|
| 6621 | "line": 183,
|
| 6622 | "character": 29
|
| 6623 | }
|
| 6624 | ]
|
| 6625 | }
|
| 6626 | }
|
| 6627 | ]
|
| 6628 | }
|
| 6629 | },
|
| 6630 | {
|
| 6631 | "id": 170,
|
| 6632 | "name": "configurable",
|
| 6633 | "kind": 1024,
|
| 6634 | "kindString": "Property",
|
| 6635 | "flags": {
|
| 6636 | "isOptional": true
|
| 6637 | },
|
| 6638 | "comment": {
|
| 6639 | "shortText": "Whether this field extension needs some configuration options before being\ninstalled in a field or not. Will trigger the\n`renderManualFieldExtensionConfigScreen` and\n`validateManualFieldExtensionParameters` methods"
|
| 6640 | },
|
| 6641 | "sources": [
|
| 6642 | {
|
| 6643 | "fileName": "types.ts",
|
| 6644 | "line": 192,
|
| 6645 | "character": 2
|
| 6646 | }
|
| 6647 | ],
|
| 6648 | "type": {
|
| 6649 | "type": "union",
|
| 6650 | "types": [
|
| 6651 | {
|
| 6652 | "type": "intrinsic",
|
| 6653 | "name": "boolean"
|
| 6654 | },
|
| 6655 | {
|
| 6656 | "type": "reflection",
|
| 6657 | "declaration": {
|
| 6658 | "id": 171,
|
| 6659 | "name": "__type",
|
| 6660 | "kind": 65536,
|
| 6661 | "kindString": "Type literal",
|
| 6662 | "flags": {},
|
| 6663 | "children": [
|
| 6664 | {
|
| 6665 | "id": 172,
|
| 6666 | "name": "initialHeight",
|
| 6667 | "kind": 1024,
|
| 6668 | "kindString": "Property",
|
| 6669 | "flags": {},
|
| 6670 | "sources": [
|
| 6671 | {
|
| 6672 | "fileName": "types.ts",
|
| 6673 | "line": 192,
|
| 6674 | "character": 29
|
| 6675 | }
|
| 6676 | ],
|
| 6677 | "type": {
|
| 6678 | "type": "intrinsic",
|
| 6679 | "name": "number"
|
| 6680 | }
|
| 6681 | }
|
| 6682 | ],
|
| 6683 | "groups": [
|
| 6684 | {
|
| 6685 | "title": "Properties",
|
| 6686 | "kind": 1024,
|
| 6687 | "children": [
|
| 6688 | 172
|
| 6689 | ]
|
| 6690 | }
|
| 6691 | ],
|
| 6692 | "sources": [
|
| 6693 | {
|
| 6694 | "fileName": "types.ts",
|
| 6695 | "line": 192,
|
| 6696 | "character": 27
|
| 6697 | }
|
| 6698 | ]
|
| 6699 | }
|
| 6700 | }
|
| 6701 | ]
|
| 6702 | }
|
| 6703 | },
|
| 6704 | {
|
| 6705 | "id": 169,
|
| 6706 | "name": "fieldTypes",
|
| 6707 | "kind": 1024,
|
| 6708 | "kindString": "Property",
|
| 6709 | "flags": {},
|
| 6710 | "comment": {
|
| 6711 | "shortText": "The type of fields that the field extension in compatible with"
|
| 6712 | },
|
| 6713 | "sources": [
|
| 6714 | {
|
| 6715 | "fileName": "types.ts",
|
| 6716 | "line": 185,
|
| 6717 | "character": 2
|
| 6718 | }
|
| 6719 | ],
|
| 6720 | "type": {
|
| 6721 | "type": "reference",
|
| 6722 | "typeArguments": [
|
| 6723 | {
|
| 6724 | "type": "indexedAccess",
|
| 6725 | "indexType": {
|
| 6726 | "type": "literal",
|
| 6727 | "value": "field_types"
|
| 6728 | },
|
| 6729 | "objectType": {
|
| 6730 | "type": "reference",
|
| 6731 | "name": "PluginAttributes"
|
| 6732 | }
|
| 6733 | }
|
| 6734 | ],
|
| 6735 | "name": "NonNullable"
|
| 6736 | }
|
| 6737 | },
|
| 6738 | {
|
| 6739 | "id": 163,
|
| 6740 | "name": "id",
|
| 6741 | "kind": 1024,
|
| 6742 | "kindString": "Property",
|
| 6743 | "flags": {},
|
| 6744 | "comment": {
|
| 6745 | "shortText": "ID of field extension. Will be the first argument for the\n`renderFieldExtension` function"
|
| 6746 | },
|
| 6747 | "sources": [
|
| 6748 | {
|
| 6749 | "fileName": "types.ts",
|
| 6750 | "line": 169,
|
| 6751 | "character": 2
|
| 6752 | }
|
| 6753 | ],
|
| 6754 | "type": {
|
| 6755 | "type": "intrinsic",
|
| 6756 | "name": "string"
|
| 6757 | }
|
| 6758 | },
|
| 6759 | {
|
| 6760 | "id": 173,
|
| 6761 | "name": "initialHeight",
|
| 6762 | "kind": 1024,
|
| 6763 | "kindString": "Property",
|
| 6764 | "flags": {
|
| 6765 | "isOptional": true
|
| 6766 | },
|
| 6767 | "comment": {
|
| 6768 | "shortText": "The initial height to set for the iframe that will render the field extension"
|
| 6769 | },
|
| 6770 | "sources": [
|
| 6771 | {
|
| 6772 | "fileName": "types.ts",
|
| 6773 | "line": 194,
|
| 6774 | "character": 2
|
| 6775 | }
|
| 6776 | ],
|
| 6777 | "type": {
|
| 6778 | "type": "intrinsic",
|
| 6779 | "name": "number"
|
| 6780 | }
|
| 6781 | },
|
| 6782 | {
|
| 6783 | "id": 164,
|
| 6784 | "name": "name",
|
| 6785 | "kind": 1024,
|
| 6786 | "kindString": "Property",
|
| 6787 | "flags": {},
|
| 6788 | "comment": {
|
| 6789 | "shortText": "Name to be shown when editing fields"
|
| 6790 | },
|
| 6791 | "sources": [
|
| 6792 | {
|
| 6793 | "fileName": "types.ts",
|
| 6794 | "line": 171,
|
| 6795 | "character": 2
|
| 6796 | }
|
| 6797 | ],
|
| 6798 | "type": {
|
| 6799 | "type": "intrinsic",
|
| 6800 | "name": "string"
|
| 6801 | }
|
| 6802 | },
|
| 6803 | {
|
| 6804 | "id": 165,
|
| 6805 | "name": "type",
|
| 6806 | "kind": 1024,
|
| 6807 | "kindString": "Property",
|
| 6808 | "flags": {},
|
| 6809 | "comment": {
|
| 6810 | "shortText": "Type of field extension. An `editor` extension replaces the default field\neditor that DatoCMS provides, while an `addon` extension is placed\nunderneath the field editor to provide additional info/behaviour. You can\nsetup multiple field addons for every field."
|
| 6811 | },
|
| 6812 | "sources": [
|
| 6813 | {
|
| 6814 | "fileName": "types.ts",
|
| 6815 | "line": 178,
|
| 6816 | "character": 2
|
| 6817 | }
|
| 6818 | ],
|
| 6819 | "type": {
|
| 6820 | "type": "reference",
|
| 6821 | "id": 160,
|
| 6822 | "name": "FieldExtensionType"
|
| 6823 | }
|
| 6824 | }
|
| 6825 | ],
|
| 6826 | "groups": [
|
| 6827 | {
|
| 6828 | "title": "Properties",
|
| 6829 | "kind": 1024,
|
| 6830 | "children": [
|
| 6831 | 166,
|
| 6832 | 170,
|
| 6833 | 169,
|
| 6834 | 163,
|
| 6835 | 173,
|
| 6836 | 164,
|
| 6837 | 165
|
| 6838 | ]
|
| 6839 | }
|
| 6840 | ],
|
| 6841 | "sources": [
|
| 6842 | {
|
| 6843 | "fileName": "types.ts",
|
| 6844 | "line": 164,
|
| 6845 | "character": 35
|
| 6846 | }
|
| 6847 | ]
|
| 6848 | }
|
| 6849 | }
|
| 6850 | },
|
| 6851 | {
|
| 6852 | "id": 222,
|
| 6853 | "name": "Modal",
|
| 6854 | "kind": 4194304,
|
| 6855 | "kindString": "Type alias",
|
| 6856 | "flags": {},
|
| 6857 | "comment": {
|
| 6858 | "shortText": "A modal to present to the user"
|
| 6859 | },
|
| 6860 | "sources": [
|
| 6861 | {
|
| 6862 | "fileName": "types.ts",
|
| 6863 | "line": 331,
|
| 6864 | "character": 12
|
| 6865 | }
|
| 6866 | ],
|
| 6867 | "type": {
|
| 6868 | "type": "reflection",
|
| 6869 | "declaration": {
|
| 6870 | "id": 223,
|
| 6871 | "name": "__type",
|
| 6872 | "kind": 65536,
|
| 6873 | "kindString": "Type literal",
|
| 6874 | "flags": {},
|
| 6875 | "children": [
|
| 6876 | {
|
| 6877 | "id": 226,
|
| 6878 | "name": "closeDisabled",
|
| 6879 | "kind": 1024,
|
| 6880 | "kindString": "Property",
|
| 6881 | "flags": {
|
| 6882 | "isOptional": true
|
| 6883 | },
|
| 6884 | "comment": {
|
| 6885 | "shortText": "Whether to present a close button for the modal or not"
|
| 6886 | },
|
| 6887 | "sources": [
|
| 6888 | {
|
| 6889 | "fileName": "types.ts",
|
| 6890 | "line": 337,
|
| 6891 | "character": 2
|
| 6892 | }
|
| 6893 | ],
|
| 6894 | "type": {
|
| 6895 | "type": "intrinsic",
|
| 6896 | "name": "boolean"
|
| 6897 | }
|
| 6898 | },
|
| 6899 | {
|
| 6900 | "id": 224,
|
| 6901 | "name": "id",
|
| 6902 | "kind": 1024,
|
| 6903 | "kindString": "Property",
|
| 6904 | "flags": {},
|
| 6905 | "comment": {
|
| 6906 | "shortText": "ID of the modal. Will be the first argument for the `renderModal` function"
|
| 6907 | },
|
| 6908 | "sources": [
|
| 6909 | {
|
| 6910 | "fileName": "types.ts",
|
| 6911 | "line": 333,
|
| 6912 | "character": 2
|
| 6913 | }
|
| 6914 | ],
|
| 6915 | "type": {
|
| 6916 | "type": "intrinsic",
|
| 6917 | "name": "string"
|
| 6918 | }
|
| 6919 | },
|
| 6920 | {
|
| 6921 | "id": 229,
|
| 6922 | "name": "initialHeight",
|
| 6923 | "kind": 1024,
|
| 6924 | "kindString": "Property",
|
| 6925 | "flags": {
|
| 6926 | "isOptional": true
|
| 6927 | },
|
| 6928 | "comment": {
|
| 6929 | "shortText": "The initial height to set for the iframe that will render the modal content"
|
| 6930 | },
|
| 6931 | "sources": [
|
| 6932 | {
|
| 6933 | "fileName": "types.ts",
|
| 6934 | "line": 346,
|
| 6935 | "character": 2
|
| 6936 | }
|
| 6937 | ],
|
| 6938 | "type": {
|
| 6939 | "type": "intrinsic",
|
| 6940 | "name": "number"
|
| 6941 | }
|
| 6942 | },
|
| 6943 | {
|
| 6944 | "id": 228,
|
| 6945 | "name": "parameters",
|
| 6946 | "kind": 1024,
|
| 6947 | "kindString": "Property",
|
| 6948 | "flags": {
|
| 6949 | "isOptional": true
|
| 6950 | },
|
| 6951 | "comment": {
|
| 6952 | "shortText": "An arbitrary configuration object that will be passed as the `parameters`\nproperty of the second argument of the `renderModal` function"
|
| 6953 | },
|
| 6954 | "sources": [
|
| 6955 | {
|
| 6956 | "fileName": "types.ts",
|
| 6957 | "line": 344,
|
| 6958 | "character": 2
|
| 6959 | }
|
| 6960 | ],
|
| 6961 | "type": {
|
| 6962 | "type": "reference",
|
| 6963 | "typeArguments": [
|
| 6964 | {
|
| 6965 | "type": "intrinsic",
|
| 6966 | "name": "string"
|
| 6967 | },
|
| 6968 | {
|
| 6969 | "type": "intrinsic",
|
| 6970 | "name": "unknown"
|
| 6971 | }
|
| 6972 | ],
|
| 6973 | "name": "Record"
|
| 6974 | }
|
| 6975 | },
|
| 6976 | {
|
| 6977 | "id": 225,
|
| 6978 | "name": "title",
|
| 6979 | "kind": 1024,
|
| 6980 | "kindString": "Property",
|
| 6981 | "flags": {
|
| 6982 | "isOptional": true
|
| 6983 | },
|
| 6984 | "comment": {
|
| 6985 | "shortText": "Title for the modal. Ignored by `fullWidth` modals"
|
| 6986 | },
|
| 6987 | "sources": [
|
| 6988 | {
|
| 6989 | "fileName": "types.ts",
|
| 6990 | "line": 335,
|
| 6991 | "character": 2
|
| 6992 | }
|
| 6993 | ],
|
| 6994 | "type": {
|
| 6995 | "type": "intrinsic",
|
| 6996 | "name": "string"
|
| 6997 | }
|
| 6998 | },
|
| 6999 | {
|
| 7000 | "id": 227,
|
| 7001 | "name": "width",
|
| 7002 | "kind": 1024,
|
| 7003 | "kindString": "Property",
|
| 7004 | "flags": {
|
| 7005 | "isOptional": true
|
| 7006 | },
|
| 7007 | "comment": {
|
| 7008 | "shortText": "Width of the modal. Can be a number, or one of the predefined sizes"
|
| 7009 | },
|
| 7010 | "sources": [
|
| 7011 | {
|
| 7012 | "fileName": "types.ts",
|
| 7013 | "line": 339,
|
| 7014 | "character": 2
|
| 7015 | }
|
| 7016 | ],
|
| 7017 | "type": {
|
| 7018 | "type": "union",
|
| 7019 | "types": [
|
| 7020 | {
|
| 7021 | "type": "literal",
|
| 7022 | "value": "s"
|
| 7023 | },
|
| 7024 | {
|
| 7025 | "type": "literal",
|
| 7026 | "value": "m"
|
| 7027 | },
|
| 7028 | {
|
| 7029 | "type": "literal",
|
| 7030 | "value": "l"
|
| 7031 | },
|
| 7032 | {
|
| 7033 | "type": "literal",
|
| 7034 | "value": "xl"
|
| 7035 | },
|
| 7036 | {
|
| 7037 | "type": "literal",
|
| 7038 | "value": "fullWidth"
|
| 7039 | },
|
| 7040 | {
|
| 7041 | "type": "intrinsic",
|
| 7042 | "name": "number"
|
| 7043 | }
|
| 7044 | ]
|
| 7045 | }
|
| 7046 | }
|
| 7047 | ],
|
| 7048 | "groups": [
|
| 7049 | {
|
| 7050 | "title": "Properties",
|
| 7051 | "kind": 1024,
|
| 7052 | "children": [
|
| 7053 | 226,
|
| 7054 | 224,
|
| 7055 | 229,
|
| 7056 | 228,
|
| 7057 | 225,
|
| 7058 | 227
|
| 7059 | ]
|
| 7060 | }
|
| 7061 | ],
|
| 7062 | "sources": [
|
| 7063 | {
|
| 7064 | "fileName": "types.ts",
|
| 7065 | "line": 331,
|
| 7066 | "character": 20
|
| 7067 | }
|
| 7068 | ]
|
| 7069 | }
|
| 7070 | }
|
| 7071 | },
|
| 7072 | {
|
| 7073 | "id": 387,
|
| 7074 | "name": "NavigateMethods",
|
| 7075 | "kind": 4194304,
|
| 7076 | "kindString": "Type alias",
|
| 7077 | "flags": {},
|
| 7078 | "comment": {
|
| 7079 | "shortText": "These methods can be used to take the user to different pages"
|
| 7080 | },
|
| 7081 | "sources": [
|
| 7082 | {
|
| 7083 | "fileName": "types.ts",
|
| 7084 | "line": 927,
|
| 7085 | "character": 12
|
| 7086 | }
|
| 7087 | ],
|
| 7088 | "type": {
|
| 7089 | "type": "reflection",
|
| 7090 | "declaration": {
|
| 7091 | "id": 388,
|
| 7092 | "name": "__type",
|
| 7093 | "kind": 65536,
|
| 7094 | "kindString": "Type literal",
|
| 7095 | "flags": {},
|
| 7096 | "children": [
|
| 7097 | {
|
| 7098 | "id": 389,
|
| 7099 | "name": "navigateTo",
|
| 7100 | "kind": 2048,
|
| 7101 | "kindString": "Method",
|
| 7102 | "flags": {},
|
| 7103 | "sources": [
|
| 7104 | {
|
| 7105 | "fileName": "types.ts",
|
| 7106 | "line": 937,
|
| 7107 | "character": 2
|
| 7108 | }
|
| 7109 | ],
|
| 7110 | "signatures": [
|
| 7111 | {
|
| 7112 | "id": 390,
|
| 7113 | "name": "navigateTo",
|
| 7114 | "kind": 4096,
|
| 7115 | "kindString": "Call signature",
|
| 7116 | "flags": {},
|
| 7117 | "comment": {
|
| 7118 | "shortText": "Moves the user to another URL internal to the backend",
|
| 7119 | "tags": [
|
| 7120 | {
|
| 7121 | "tag": "example",
|
| 7122 | "text": "\n\n```js\nawait ctx.navigateTo('/');\n```\n"
|
| 7123 | }
|
| 7124 | ]
|
| 7125 | },
|
| 7126 | "parameters": [
|
| 7127 | {
|
| 7128 | "id": 391,
|
| 7129 | "name": "path",
|
| 7130 | "kind": 32768,
|
| 7131 | "kindString": "Parameter",
|
| 7132 | "flags": {},
|
| 7133 | "type": {
|
| 7134 | "type": "intrinsic",
|
| 7135 | "name": "string"
|
| 7136 | }
|
| 7137 | }
|
| 7138 | ],
|
| 7139 | "type": {
|
| 7140 | "type": "reference",
|
| 7141 | "typeArguments": [
|
| 7142 | {
|
| 7143 | "type": "intrinsic",
|
| 7144 | "name": "void"
|
| 7145 | }
|
| 7146 | ],
|
| 7147 | "name": "Promise"
|
| 7148 | }
|
| 7149 | }
|
| 7150 | ]
|
| 7151 | }
|
| 7152 | ],
|
| 7153 | "groups": [
|
| 7154 | {
|
| 7155 | "title": "Methods",
|
| 7156 | "kind": 2048,
|
| 7157 | "children": [
|
| 7158 | 389
|
| 7159 | ]
|
| 7160 | }
|
| 7161 | ],
|
| 7162 | "sources": [
|
| 7163 | {
|
| 7164 | "fileName": "types.ts",
|
| 7165 | "line": 927,
|
| 7166 | "character": 30
|
| 7167 | }
|
| 7168 | ]
|
| 7169 | }
|
| 7170 | }
|
| 7171 | },
|
| 7172 | {
|
| 7173 | "id": 530,
|
| 7174 | "name": "OnBootAdditionalMethods",
|
| 7175 | "kind": 4194304,
|
| 7176 | "kindString": "Type alias",
|
| 7177 | "flags": {},
|
| 7178 | "sources": [
|
| 7179 | {
|
| 7180 | "fileName": "types.ts",
|
| 7181 | "line": 1274,
|
| 7182 | "character": 12
|
| 7183 | }
|
| 7184 | ],
|
| 7185 | "type": {
|
| 7186 | "type": "reflection",
|
| 7187 | "declaration": {
|
| 7188 | "id": 531,
|
| 7189 | "name": "__type",
|
| 7190 | "kind": 65536,
|
| 7191 | "kindString": "Type literal",
|
| 7192 | "flags": {},
|
| 7193 | "children": [
|
| 7194 | {
|
| 7195 | "id": 532,
|
| 7196 | "name": "getSettings",
|
| 7197 | "kind": 2048,
|
| 7198 | "kindString": "Method",
|
| 7199 | "flags": {},
|
| 7200 | "sources": [
|
| 7201 | {
|
| 7202 | "fileName": "types.ts",
|
| 7203 | "line": 1275,
|
| 7204 | "character": 2
|
| 7205 | }
|
| 7206 | ],
|
| 7207 | "signatures": [
|
| 7208 | {
|
| 7209 | "id": 533,
|
| 7210 | "name": "getSettings",
|
| 7211 | "kind": 4096,
|
| 7212 | "kindString": "Call signature",
|
| 7213 | "flags": {},
|
| 7214 | "type": {
|
| 7215 | "type": "reference",
|
| 7216 | "typeArguments": [
|
| 7217 | {
|
| 7218 | "type": "reference",
|
| 7219 | "id": 529,
|
| 7220 | "name": "OnBootProperties"
|
| 7221 | }
|
| 7222 | ],
|
| 7223 | "name": "Promise"
|
| 7224 | }
|
| 7225 | }
|
| 7226 | ]
|
| 7227 | }
|
| 7228 | ],
|
| 7229 | "groups": [
|
| 7230 | {
|
| 7231 | "title": "Methods",
|
| 7232 | "kind": 2048,
|
| 7233 | "children": [
|
| 7234 | 532
|
| 7235 | ]
|
| 7236 | }
|
| 7237 | ],
|
| 7238 | "sources": [
|
| 7239 | {
|
| 7240 | "fileName": "types.ts",
|
| 7241 | "line": 1274,
|
| 7242 | "character": 38
|
| 7243 | }
|
| 7244 | ]
|
| 7245 | }
|
| 7246 | }
|
| 7247 | },
|
| 7248 | {
|
| 7249 | "id": 526,
|
| 7250 | "name": "OnBootAdditionalProperties",
|
| 7251 | "kind": 4194304,
|
| 7252 | "kindString": "Type alias",
|
| 7253 | "flags": {},
|
| 7254 | "sources": [
|
| 7255 | {
|
| 7256 | "fileName": "types.ts",
|
| 7257 | "line": 1268,
|
| 7258 | "character": 12
|
| 7259 | }
|
| 7260 | ],
|
| 7261 | "type": {
|
| 7262 | "type": "reflection",
|
| 7263 | "declaration": {
|
| 7264 | "id": 527,
|
| 7265 | "name": "__type",
|
| 7266 | "kind": 65536,
|
| 7267 | "kindString": "Type literal",
|
| 7268 | "flags": {},
|
| 7269 | "children": [
|
| 7270 | {
|
| 7271 | "id": 528,
|
| 7272 | "name": "mode",
|
| 7273 | "kind": 1024,
|
| 7274 | "kindString": "Property",
|
| 7275 | "flags": {},
|
| 7276 | "sources": [
|
| 7277 | {
|
| 7278 | "fileName": "types.ts",
|
| 7279 | "line": 1269,
|
| 7280 | "character": 2
|
| 7281 | }
|
| 7282 | ],
|
| 7283 | "type": {
|
| 7284 | "type": "literal",
|
| 7285 | "value": "onBoot"
|
| 7286 | }
|
| 7287 | }
|
| 7288 | ],
|
| 7289 | "groups": [
|
| 7290 | {
|
| 7291 | "title": "Properties",
|
| 7292 | "kind": 1024,
|
| 7293 | "children": [
|
| 7294 | 528
|
| 7295 | ]
|
| 7296 | }
|
| 7297 | ],
|
| 7298 | "sources": [
|
| 7299 | {
|
| 7300 | "fileName": "types.ts",
|
| 7301 | "line": 1268,
|
| 7302 | "character": 41
|
| 7303 | }
|
| 7304 | ]
|
| 7305 | }
|
| 7306 | }
|
| 7307 | },
|
| 7308 | {
|
| 7309 | "id": 67,
|
| 7310 | "name": "OnBootCtx",
|
| 7311 | "kind": 4194304,
|
| 7312 | "kindString": "Type alias",
|
| 7313 | "flags": {},
|
| 7314 | "sources": [
|
| 7315 | {
|
| 7316 | "fileName": "connect.ts",
|
| 7317 | "line": 57,
|
| 7318 | "character": 12
|
| 7319 | }
|
| 7320 | ],
|
| 7321 | "type": {
|
| 7322 | "type": "reference",
|
| 7323 | "id": 535,
|
| 7324 | "name": "OnBootPropertiesAndMethods"
|
| 7325 | }
|
| 7326 | },
|
| 7327 | {
|
| 7328 | "id": 534,
|
| 7329 | "name": "OnBootMethods",
|
| 7330 | "kind": 4194304,
|
| 7331 | "kindString": "Type alias",
|
| 7332 | "flags": {},
|
| 7333 | "sources": [
|
| 7334 | {
|
| 7335 | "fileName": "types.ts",
|
| 7336 | "line": 1278,
|
| 7337 | "character": 12
|
| 7338 | }
|
| 7339 | ],
|
| 7340 | "type": {
|
| 7341 | "type": "intersection",
|
| 7342 | "types": [
|
| 7343 | {
|
| 7344 | "type": "reference",
|
| 7345 | "id": 397,
|
| 7346 | "name": "RenderMethods"
|
| 7347 | },
|
| 7348 | {
|
| 7349 | "type": "reference",
|
| 7350 | "id": 530,
|
| 7351 | "name": "OnBootAdditionalMethods"
|
| 7352 | }
|
| 7353 | ]
|
| 7354 | }
|
| 7355 | },
|
| 7356 | {
|
| 7357 | "id": 529,
|
| 7358 | "name": "OnBootProperties",
|
| 7359 | "kind": 4194304,
|
| 7360 | "kindString": "Type alias",
|
| 7361 | "flags": {},
|
| 7362 | "sources": [
|
| 7363 | {
|
| 7364 | "fileName": "types.ts",
|
| 7365 | "line": 1272,
|
| 7366 | "character": 12
|
| 7367 | }
|
| 7368 | ],
|
| 7369 | "type": {
|
| 7370 | "type": "intersection",
|
| 7371 | "types": [
|
| 7372 | {
|
| 7373 | "type": "reference",
|
| 7374 | "id": 281,
|
| 7375 | "name": "RenderProperties"
|
| 7376 | },
|
| 7377 | {
|
| 7378 | "type": "reference",
|
| 7379 | "id": 526,
|
| 7380 | "name": "OnBootAdditionalProperties"
|
| 7381 | }
|
| 7382 | ]
|
| 7383 | }
|
| 7384 | },
|
| 7385 | {
|
| 7386 | "id": 535,
|
| 7387 | "name": "OnBootPropertiesAndMethods",
|
| 7388 | "kind": 4194304,
|
| 7389 | "kindString": "Type alias",
|
| 7390 | "flags": {},
|
| 7391 | "sources": [
|
| 7392 | {
|
| 7393 | "fileName": "types.ts",
|
| 7394 | "line": 1280,
|
| 7395 | "character": 12
|
| 7396 | }
|
| 7397 | ],
|
| 7398 | "type": {
|
| 7399 | "type": "intersection",
|
| 7400 | "types": [
|
| 7401 | {
|
| 7402 | "type": "reference",
|
| 7403 | "id": 534,
|
| 7404 | "name": "OnBootMethods"
|
| 7405 | },
|
| 7406 | {
|
| 7407 | "type": "reference",
|
| 7408 | "id": 529,
|
| 7409 | "name": "OnBootProperties"
|
| 7410 | }
|
| 7411 | ]
|
| 7412 | }
|
| 7413 | },
|
| 7414 | {
|
| 7415 | "id": 484,
|
| 7416 | "name": "PendingField",
|
| 7417 | "kind": 4194304,
|
| 7418 | "kindString": "Type alias",
|
| 7419 | "flags": {},
|
| 7420 | "sources": [
|
| 7421 | {
|
| 7422 | "fileName": "types.ts",
|
| 7423 | "line": 1180,
|
| 7424 | "character": 12
|
| 7425 | }
|
| 7426 | ],
|
| 7427 | "type": {
|
| 7428 | "type": "reflection",
|
| 7429 | "declaration": {
|
| 7430 | "id": 485,
|
| 7431 | "name": "__type",
|
| 7432 | "kind": 65536,
|
| 7433 | "kindString": "Type literal",
|
| 7434 | "flags": {},
|
| 7435 | "children": [
|
| 7436 | {
|
| 7437 | "id": 488,
|
| 7438 | "name": "attributes",
|
| 7439 | "kind": 1024,
|
| 7440 | "kindString": "Property",
|
| 7441 | "flags": {},
|
| 7442 | "sources": [
|
| 7443 | {
|
| 7444 | "fileName": "types.ts",
|
| 7445 | "line": 1183,
|
| 7446 | "character": 2
|
| 7447 | }
|
| 7448 | ],
|
| 7449 | "type": {
|
| 7450 | "type": "reflection",
|
| 7451 | "declaration": {
|
| 7452 | "id": 489,
|
| 7453 | "name": "__type",
|
| 7454 | "kind": 65536,
|
| 7455 | "kindString": "Type literal",
|
| 7456 | "flags": {},
|
| 7457 | "children": [
|
| 7458 | {
|
| 7459 | "id": 490,
|
| 7460 | "name": "api_key",
|
| 7461 | "kind": 1024,
|
| 7462 | "kindString": "Property",
|
| 7463 | "flags": {},
|
| 7464 | "sources": [
|
| 7465 | {
|
| 7466 | "fileName": "types.ts",
|
| 7467 | "line": 1184,
|
| 7468 | "character": 4
|
| 7469 | }
|
| 7470 | ],
|
| 7471 | "type": {
|
| 7472 | "type": "indexedAccess",
|
| 7473 | "indexType": {
|
| 7474 | "type": "literal",
|
| 7475 | "value": "api_key"
|
| 7476 | },
|
| 7477 | "objectType": {
|
| 7478 | "type": "indexedAccess",
|
| 7479 | "indexType": {
|
| 7480 | "type": "literal",
|
| 7481 | "value": "attributes"
|
| 7482 | },
|
| 7483 | "objectType": {
|
| 7484 | "type": "reference",
|
| 7485 | "id": 5,
|
| 7486 | "name": "Field"
|
| 7487 | }
|
| 7488 | }
|
| 7489 | }
|
| 7490 | },
|
| 7491 | {
|
| 7492 | "id": 491,
|
| 7493 | "name": "appearance",
|
| 7494 | "kind": 1024,
|
| 7495 | "kindString": "Property",
|
| 7496 | "flags": {},
|
| 7497 | "sources": [
|
| 7498 | {
|
| 7499 | "fileName": "types.ts",
|
| 7500 | "line": 1185,
|
| 7501 | "character": 4
|
| 7502 | }
|
| 7503 | ],
|
| 7504 | "type": {
|
| 7505 | "type": "indexedAccess",
|
| 7506 | "indexType": {
|
| 7507 | "type": "literal",
|
| 7508 | "value": "appearance"
|
| 7509 | },
|
| 7510 | "objectType": {
|
| 7511 | "type": "indexedAccess",
|
| 7512 | "indexType": {
|
| 7513 | "type": "literal",
|
| 7514 | "value": "attributes"
|
| 7515 | },
|
| 7516 | "objectType": {
|
| 7517 | "type": "reference",
|
| 7518 | "id": 5,
|
| 7519 | "name": "Field"
|
| 7520 | }
|
| 7521 | }
|
| 7522 | }
|
| 7523 | },
|
| 7524 | {
|
| 7525 | "id": 492,
|
| 7526 | "name": "default_value",
|
| 7527 | "kind": 1024,
|
| 7528 | "kindString": "Property",
|
| 7529 | "flags": {},
|
| 7530 | "sources": [
|
| 7531 | {
|
| 7532 | "fileName": "types.ts",
|
| 7533 | "line": 1186,
|
| 7534 | "character": 4
|
| 7535 | }
|
| 7536 | ],
|
| 7537 | "type": {
|
| 7538 | "type": "indexedAccess",
|
| 7539 | "indexType": {
|
| 7540 | "type": "literal",
|
| 7541 | "value": "default_value"
|
| 7542 | },
|
| 7543 | "objectType": {
|
| 7544 | "type": "indexedAccess",
|
| 7545 | "indexType": {
|
| 7546 | "type": "literal",
|
| 7547 | "value": "attributes"
|
| 7548 | },
|
| 7549 | "objectType": {
|
| 7550 | "type": "reference",
|
| 7551 | "id": 5,
|
| 7552 | "name": "Field"
|
| 7553 | }
|
| 7554 | }
|
| 7555 | }
|
| 7556 | },
|
| 7557 | {
|
| 7558 | "id": 493,
|
| 7559 | "name": "field_type",
|
| 7560 | "kind": 1024,
|
| 7561 | "kindString": "Property",
|
| 7562 | "flags": {},
|
| 7563 | "sources": [
|
| 7564 | {
|
| 7565 | "fileName": "types.ts",
|
| 7566 | "line": 1187,
|
| 7567 | "character": 4
|
| 7568 | }
|
| 7569 | ],
|
| 7570 | "type": {
|
| 7571 | "type": "indexedAccess",
|
| 7572 | "indexType": {
|
| 7573 | "type": "literal",
|
| 7574 | "value": "field_type"
|
| 7575 | },
|
| 7576 | "objectType": {
|
| 7577 | "type": "indexedAccess",
|
| 7578 | "indexType": {
|
| 7579 | "type": "literal",
|
| 7580 | "value": "attributes"
|
| 7581 | },
|
| 7582 | "objectType": {
|
| 7583 | "type": "reference",
|
| 7584 | "id": 5,
|
| 7585 | "name": "Field"
|
| 7586 | }
|
| 7587 | }
|
| 7588 | }
|
| 7589 | },
|
| 7590 | {
|
| 7591 | "id": 494,
|
| 7592 | "name": "hint",
|
| 7593 | "kind": 1024,
|
| 7594 | "kindString": "Property",
|
| 7595 | "flags": {},
|
| 7596 | "sources": [
|
| 7597 | {
|
| 7598 | "fileName": "types.ts",
|
| 7599 | "line": 1188,
|
| 7600 | "character": 4
|
| 7601 | }
|
| 7602 | ],
|
| 7603 | "type": {
|
| 7604 | "type": "indexedAccess",
|
| 7605 | "indexType": {
|
| 7606 | "type": "literal",
|
| 7607 | "value": "hint"
|
| 7608 | },
|
| 7609 | "objectType": {
|
| 7610 | "type": "indexedAccess",
|
| 7611 | "indexType": {
|
| 7612 | "type": "literal",
|
| 7613 | "value": "attributes"
|
| 7614 | },
|
| 7615 | "objectType": {
|
| 7616 | "type": "reference",
|
| 7617 | "id": 5,
|
| 7618 | "name": "Field"
|
| 7619 | }
|
| 7620 | }
|
| 7621 | }
|
| 7622 | },
|
| 7623 | {
|
| 7624 | "id": 495,
|
| 7625 | "name": "label",
|
| 7626 | "kind": 1024,
|
| 7627 | "kindString": "Property",
|
| 7628 | "flags": {},
|
| 7629 | "sources": [
|
| 7630 | {
|
| 7631 | "fileName": "types.ts",
|
| 7632 | "line": 1189,
|
| 7633 | "character": 4
|
| 7634 | }
|
| 7635 | ],
|
| 7636 | "type": {
|
| 7637 | "type": "indexedAccess",
|
| 7638 | "indexType": {
|
| 7639 | "type": "literal",
|
| 7640 | "value": "label"
|
| 7641 | },
|
| 7642 | "objectType": {
|
| 7643 | "type": "indexedAccess",
|
| 7644 | "indexType": {
|
| 7645 | "type": "literal",
|
| 7646 | "value": "attributes"
|
| 7647 | },
|
| 7648 | "objectType": {
|
| 7649 | "type": "reference",
|
| 7650 | "id": 5,
|
| 7651 | "name": "Field"
|
| 7652 | }
|
| 7653 | }
|
| 7654 | }
|
| 7655 | },
|
| 7656 | {
|
| 7657 | "id": 496,
|
| 7658 | "name": "localized",
|
| 7659 | "kind": 1024,
|
| 7660 | "kindString": "Property",
|
| 7661 | "flags": {},
|
| 7662 | "sources": [
|
| 7663 | {
|
| 7664 | "fileName": "types.ts",
|
| 7665 | "line": 1190,
|
| 7666 | "character": 4
|
| 7667 | }
|
| 7668 | ],
|
| 7669 | "type": {
|
| 7670 | "type": "indexedAccess",
|
| 7671 | "indexType": {
|
| 7672 | "type": "literal",
|
| 7673 | "value": "localized"
|
| 7674 | },
|
| 7675 | "objectType": {
|
| 7676 | "type": "indexedAccess",
|
| 7677 | "indexType": {
|
| 7678 | "type": "literal",
|
| 7679 | "value": "attributes"
|
| 7680 | },
|
| 7681 | "objectType": {
|
| 7682 | "type": "reference",
|
| 7683 | "id": 5,
|
| 7684 | "name": "Field"
|
| 7685 | }
|
| 7686 | }
|
| 7687 | }
|
| 7688 | },
|
| 7689 | {
|
| 7690 | "id": 497,
|
| 7691 | "name": "validators",
|
| 7692 | "kind": 1024,
|
| 7693 | "kindString": "Property",
|
| 7694 | "flags": {},
|
| 7695 | "sources": [
|
| 7696 | {
|
| 7697 | "fileName": "types.ts",
|
| 7698 | "line": 1191,
|
| 7699 | "character": 4
|
| 7700 | }
|
| 7701 | ],
|
| 7702 | "type": {
|
| 7703 | "type": "indexedAccess",
|
| 7704 | "indexType": {
|
| 7705 | "type": "literal",
|
| 7706 | "value": "validators"
|
| 7707 | },
|
| 7708 | "objectType": {
|
| 7709 | "type": "indexedAccess",
|
| 7710 | "indexType": {
|
| 7711 | "type": "literal",
|
| 7712 | "value": "attributes"
|
| 7713 | },
|
| 7714 | "objectType": {
|
| 7715 | "type": "reference",
|
| 7716 | "id": 5,
|
| 7717 | "name": "Field"
|
| 7718 | }
|
| 7719 | }
|
| 7720 | }
|
| 7721 | }
|
| 7722 | ],
|
| 7723 | "groups": [
|
| 7724 | {
|
| 7725 | "title": "Properties",
|
| 7726 | "kind": 1024,
|
| 7727 | "children": [
|
| 7728 | 490,
|
| 7729 | 491,
|
| 7730 | 492,
|
| 7731 | 493,
|
| 7732 | 494,
|
| 7733 | 495,
|
| 7734 | 496,
|
| 7735 | 497
|
| 7736 | ]
|
| 7737 | }
|
| 7738 | ],
|
| 7739 | "sources": [
|
| 7740 | {
|
| 7741 | "fileName": "types.ts",
|
| 7742 | "line": 1183,
|
| 7743 | "character": 14
|
| 7744 | }
|
| 7745 | ]
|
| 7746 | }
|
| 7747 | }
|
| 7748 | },
|
| 7749 | {
|
| 7750 | "id": 486,
|
| 7751 | "name": "id",
|
| 7752 | "kind": 1024,
|
| 7753 | "kindString": "Property",
|
| 7754 | "flags": {
|
| 7755 | "isOptional": true
|
| 7756 | },
|
| 7757 | "sources": [
|
| 7758 | {
|
| 7759 | "fileName": "types.ts",
|
| 7760 | "line": 1181,
|
| 7761 | "character": 2
|
| 7762 | }
|
| 7763 | ],
|
| 7764 | "type": {
|
| 7765 | "type": "intrinsic",
|
| 7766 | "name": "string"
|
| 7767 | }
|
| 7768 | },
|
| 7769 | {
|
| 7770 | "id": 487,
|
| 7771 | "name": "type",
|
| 7772 | "kind": 1024,
|
| 7773 | "kindString": "Property",
|
| 7774 | "flags": {},
|
| 7775 | "sources": [
|
| 7776 | {
|
| 7777 | "fileName": "types.ts",
|
| 7778 | "line": 1182,
|
| 7779 | "character": 2
|
| 7780 | }
|
| 7781 | ],
|
| 7782 | "type": {
|
| 7783 | "type": "literal",
|
| 7784 | "value": "field"
|
| 7785 | }
|
| 7786 | }
|
| 7787 | ],
|
| 7788 | "groups": [
|
| 7789 | {
|
| 7790 | "title": "Properties",
|
| 7791 | "kind": 1024,
|
| 7792 | "children": [
|
| 7793 | 488,
|
| 7794 | 486,
|
| 7795 | 487
|
| 7796 | ]
|
| 7797 | }
|
| 7798 | ],
|
| 7799 | "sources": [
|
| 7800 | {
|
| 7801 | "fileName": "types.ts",
|
| 7802 | "line": 1180,
|
| 7803 | "character": 27
|
| 7804 | }
|
| 7805 | ]
|
| 7806 | }
|
| 7807 | }
|
| 7808 | },
|
| 7809 | {
|
| 7810 | "id": 273,
|
| 7811 | "name": "RenderAdditionalProperties",
|
| 7812 | "kind": 4194304,
|
| 7813 | "kindString": "Type alias",
|
| 7814 | "flags": {},
|
| 7815 | "comment": {
|
| 7816 | "shortText": "Additional properties available in all `renderXXX` hooks"
|
| 7817 | },
|
| 7818 | "sources": [
|
| 7819 | {
|
| 7820 | "fileName": "types.ts",
|
| 7821 | "line": 444,
|
| 7822 | "character": 12
|
| 7823 | }
|
| 7824 | ],
|
| 7825 | "type": {
|
| 7826 | "type": "reflection",
|
| 7827 | "declaration": {
|
| 7828 | "id": 274,
|
| 7829 | "name": "__type",
|
| 7830 | "kind": 65536,
|
| 7831 | "kindString": "Type literal",
|
| 7832 | "flags": {},
|
| 7833 | "children": [
|
| 7834 | {
|
| 7835 | "id": 279,
|
| 7836 | "name": "account",
|
| 7837 | "kind": 1024,
|
| 7838 | "kindString": "Property",
|
| 7839 | "flags": {},
|
| 7840 | "comment": {
|
| 7841 | "shortText": "The project owner"
|
| 7842 | },
|
| 7843 | "sources": [
|
| 7844 | {
|
| 7845 | "fileName": "types.ts",
|
| 7846 | "line": 468,
|
| 7847 | "character": 2
|
| 7848 | }
|
| 7849 | ],
|
| 7850 | "type": {
|
| 7851 | "type": "reference",
|
| 7852 | "id": 1,
|
| 7853 | "name": "Account"
|
| 7854 | }
|
| 7855 | },
|
| 7856 | {
|
| 7857 | "id": 280,
|
| 7858 | "name": "bodyPadding",
|
| 7859 | "kind": 1024,
|
| 7860 | "kindString": "Property",
|
| 7861 | "flags": {},
|
| 7862 | "comment": {
|
| 7863 | "shortText": "The padding in px that must be applied to the body"
|
| 7864 | },
|
| 7865 | "sources": [
|
| 7866 | {
|
| 7867 | "fileName": "types.ts",
|
| 7868 | "line": 470,
|
| 7869 | "character": 2
|
| 7870 | }
|
| 7871 | ],
|
| 7872 | "type": {
|
| 7873 | "type": "tuple",
|
| 7874 | "elements": [
|
| 7875 | {
|
| 7876 | "type": "intrinsic",
|
| 7877 | "name": "number"
|
| 7878 | },
|
| 7879 | {
|
| 7880 | "type": "intrinsic",
|
| 7881 | "name": "number"
|
| 7882 | },
|
| 7883 | {
|
| 7884 | "type": "intrinsic",
|
| 7885 | "name": "number"
|
| 7886 | },
|
| 7887 | {
|
| 7888 | "type": "intrinsic",
|
| 7889 | "name": "number"
|
| 7890 | }
|
| 7891 | ]
|
| 7892 | }
|
| 7893 | },
|
| 7894 | {
|
| 7895 | "id": 275,
|
| 7896 | "name": "fields",
|
| 7897 | "kind": 1024,
|
| 7898 | "kindString": "Property",
|
| 7899 | "flags": {},
|
| 7900 | "comment": {
|
| 7901 | "shortText": "All the fields currently loaded for the current DatoCMS project, indexed by\nID. It will always contain the current model fields and all the fields of\nthe blocks it might contain via Modular Content/Structured Text fields. If\nsome fields you need are not present, use the `loadItemTypeFields` function\nto load them."
|
| 7902 | },
|
| 7903 | "sources": [
|
| 7904 | {
|
| 7905 | "fileName": "types.ts",
|
| 7906 | "line": 452,
|
| 7907 | "character": 2
|
| 7908 | }
|
| 7909 | ],
|
| 7910 | "type": {
|
| 7911 | "type": "reference",
|
| 7912 | "typeArguments": [
|
| 7913 | {
|
| 7914 | "type": "reference",
|
| 7915 | "typeArguments": [
|
| 7916 | {
|
| 7917 | "type": "intrinsic",
|
| 7918 | "name": "string"
|
| 7919 | },
|
| 7920 | {
|
| 7921 | "type": "reference",
|
| 7922 | "id": 5,
|
| 7923 | "name": "Field"
|
| 7924 | }
|
| 7925 | ],
|
| 7926 | "name": "Record"
|
| 7927 | }
|
| 7928 | ],
|
| 7929 | "name": "Partial"
|
| 7930 | }
|
| 7931 | },
|
| 7932 | {
|
| 7933 | "id": 278,
|
| 7934 | "name": "ssoUsers",
|
| 7935 | "kind": 1024,
|
| 7936 | "kindString": "Property",
|
| 7937 | "flags": {},
|
| 7938 | "comment": {
|
| 7939 | "shortText": "All the SSO users currently loaded for the current DatoCMS project, indexed\nby ID. It will always contain the current user. If some users you need are\nnot present, use the `loadSsoUsers` function to load them."
|
| 7940 | },
|
| 7941 | "sources": [
|
| 7942 | {
|
| 7943 | "fileName": "types.ts",
|
| 7944 | "line": 466,
|
| 7945 | "character": 2
|
| 7946 | }
|
| 7947 | ],
|
| 7948 | "type": {
|
| 7949 | "type": "reference",
|
| 7950 | "typeArguments": [
|
| 7951 | {
|
| 7952 | "type": "reference",
|
| 7953 | "typeArguments": [
|
| 7954 | {
|
| 7955 | "type": "intrinsic",
|
| 7956 | "name": "string"
|
| 7957 | },
|
| 7958 | {
|
| 7959 | "type": "reference",
|
| 7960 | "id": 31,
|
| 7961 | "name": "SsoUser"
|
| 7962 | }
|
| 7963 | ],
|
| 7964 | "name": "Record"
|
| 7965 | }
|
| 7966 | ],
|
| 7967 | "name": "Partial"
|
| 7968 | }
|
| 7969 | },
|
| 7970 | {
|
| 7971 | "id": 276,
|
| 7972 | "name": "theme",
|
| 7973 | "kind": 1024,
|
| 7974 | "kindString": "Property",
|
| 7975 | "flags": {},
|
| 7976 | "comment": {
|
| 7977 | "shortText": "An object containing the theme colors for the current DatoCMS project"
|
| 7978 | },
|
| 7979 | "sources": [
|
| 7980 | {
|
| 7981 | "fileName": "types.ts",
|
| 7982 | "line": 454,
|
| 7983 | "character": 2
|
| 7984 | }
|
| 7985 | ],
|
| 7986 | "type": {
|
| 7987 | "type": "reference",
|
| 7988 | "id": 204,
|
| 7989 | "name": "Theme"
|
| 7990 | }
|
| 7991 | },
|
| 7992 | {
|
| 7993 | "id": 277,
|
| 7994 | "name": "users",
|
| 7995 | "kind": 1024,
|
| 7996 | "kindString": "Property",
|
| 7997 | "flags": {},
|
| 7998 | "comment": {
|
| 7999 | "shortText": "All the regular users currently loaded for the current DatoCMS project,\nindexed by ID. It will always contain the current user. If some users you\nneed are not present, use the `loadUsers` function to load them."
|
| 8000 | },
|
| 8001 | "sources": [
|
| 8002 | {
|
| 8003 | "fileName": "types.ts",
|
| 8004 | "line": 460,
|
| 8005 | "character": 2
|
| 8006 | }
|
| 8007 | ],
|
| 8008 | "type": {
|
| 8009 | "type": "reference",
|
| 8010 | "typeArguments": [
|
| 8011 | {
|
| 8012 | "type": "reference",
|
| 8013 | "typeArguments": [
|
| 8014 | {
|
| 8015 | "type": "intrinsic",
|
| 8016 | "name": "string"
|
| 8017 | },
|
| 8018 | {
|
| 8019 | "type": "reference",
|
| 8020 | "id": 42,
|
| 8021 | "name": "User"
|
| 8022 | }
|
| 8023 | ],
|
| 8024 | "name": "Record"
|
| 8025 | }
|
| 8026 | ],
|
| 8027 | "name": "Partial"
|
| 8028 | }
|
| 8029 | }
|
| 8030 | ],
|
| 8031 | "groups": [
|
| 8032 | {
|
| 8033 | "title": "Properties",
|
| 8034 | "kind": 1024,
|
| 8035 | "children": [
|
| 8036 | 279,
|
| 8037 | 280,
|
| 8038 | 275,
|
| 8039 | 278,
|
| 8040 | 276,
|
| 8041 | 277
|
| 8042 | ]
|
| 8043 | }
|
| 8044 | ],
|
| 8045 | "sources": [
|
| 8046 | {
|
| 8047 | "fileName": "types.ts",
|
| 8048 | "line": 444,
|
| 8049 | "character": 41
|
| 8050 | }
|
| 8051 | ]
|
| 8052 | }
|
| 8053 | }
|
| 8054 | },
|
| 8055 | {
|
| 8056 | "id": 520,
|
| 8057 | "name": "RenderConfigScreenAdditionalMethods",
|
| 8058 | "kind": 4194304,
|
| 8059 | "kindString": "Type alias",
|
| 8060 | "flags": {},
|
| 8061 | "comment": {
|
| 8062 | "shortText": "These methods can be used to update the configuration object of your plugin"
|
| 8063 | },
|
| 8064 | "sources": [
|
| 8065 | {
|
| 8066 | "fileName": "types.ts",
|
| 8067 | "line": 1257,
|
| 8068 | "character": 12
|
| 8069 | }
|
| 8070 | ],
|
| 8071 | "type": {
|
| 8072 | "type": "reflection",
|
| 8073 | "declaration": {
|
| 8074 | "id": 521,
|
| 8075 | "name": "__type",
|
| 8076 | "kind": 65536,
|
| 8077 | "kindString": "Type literal",
|
| 8078 | "flags": {},
|
| 8079 | "children": [
|
| 8080 | {
|
| 8081 | "id": 522,
|
| 8082 | "name": "getSettings",
|
| 8083 | "kind": 2048,
|
| 8084 | "kindString": "Method",
|
| 8085 | "flags": {},
|
| 8086 | "sources": [
|
| 8087 | {
|
| 8088 | "fileName": "types.ts",
|
| 8089 | "line": 1258,
|
| 8090 | "character": 2
|
| 8091 | }
|
| 8092 | ],
|
| 8093 | "signatures": [
|
| 8094 | {
|
| 8095 | "id": 523,
|
| 8096 | "name": "getSettings",
|
| 8097 | "kind": 4096,
|
| 8098 | "kindString": "Call signature",
|
| 8099 | "flags": {},
|
| 8100 | "type": {
|
| 8101 | "type": "reference",
|
| 8102 | "typeArguments": [
|
| 8103 | {
|
| 8104 | "type": "reference",
|
| 8105 | "id": 519,
|
| 8106 | "name": "RenderConfigScreenProperties"
|
| 8107 | }
|
| 8108 | ],
|
| 8109 | "name": "Promise"
|
| 8110 | }
|
| 8111 | }
|
| 8112 | ]
|
| 8113 | }
|
| 8114 | ],
|
| 8115 | "groups": [
|
| 8116 | {
|
| 8117 | "title": "Methods",
|
| 8118 | "kind": 2048,
|
| 8119 | "children": [
|
| 8120 | 522
|
| 8121 | ]
|
| 8122 | }
|
| 8123 | ],
|
| 8124 | "sources": [
|
| 8125 | {
|
| 8126 | "fileName": "types.ts",
|
| 8127 | "line": 1257,
|
| 8128 | "character": 50
|
| 8129 | }
|
| 8130 | ]
|
| 8131 | }
|
| 8132 | }
|
| 8133 | },
|
| 8134 | {
|
| 8135 | "id": 516,
|
| 8136 | "name": "RenderConfigScreenAdditionalProperties",
|
| 8137 | "kind": 4194304,
|
| 8138 | "kindString": "Type alias",
|
| 8139 | "flags": {},
|
| 8140 | "sources": [
|
| 8141 | {
|
| 8142 | "fileName": "types.ts",
|
| 8143 | "line": 1249,
|
| 8144 | "character": 12
|
| 8145 | }
|
| 8146 | ],
|
| 8147 | "type": {
|
| 8148 | "type": "reflection",
|
| 8149 | "declaration": {
|
| 8150 | "id": 517,
|
| 8151 | "name": "__type",
|
| 8152 | "kind": 65536,
|
| 8153 | "kindString": "Type literal",
|
| 8154 | "flags": {},
|
| 8155 | "children": [
|
| 8156 | {
|
| 8157 | "id": 518,
|
| 8158 | "name": "mode",
|
| 8159 | "kind": 1024,
|
| 8160 | "kindString": "Property",
|
| 8161 | "flags": {},
|
| 8162 | "sources": [
|
| 8163 | {
|
| 8164 | "fileName": "types.ts",
|
| 8165 | "line": 1250,
|
| 8166 | "character": 2
|
| 8167 | }
|
| 8168 | ],
|
| 8169 | "type": {
|
| 8170 | "type": "literal",
|
| 8171 | "value": "renderConfigScreen"
|
| 8172 | }
|
| 8173 | }
|
| 8174 | ],
|
| 8175 | "groups": [
|
| 8176 | {
|
| 8177 | "title": "Properties",
|
| 8178 | "kind": 1024,
|
| 8179 | "children": [
|
| 8180 | 518
|
| 8181 | ]
|
| 8182 | }
|
| 8183 | ],
|
| 8184 | "sources": [
|
| 8185 | {
|
| 8186 | "fileName": "types.ts",
|
| 8187 | "line": 1249,
|
| 8188 | "character": 53
|
| 8189 | }
|
| 8190 | ]
|
| 8191 | }
|
| 8192 | }
|
| 8193 | },
|
| 8194 | {
|
| 8195 | "id": 76,
|
| 8196 | "name": "RenderConfigScreenCtx",
|
| 8197 | "kind": 4194304,
|
| 8198 | "kindString": "Type alias",
|
| 8199 | "flags": {},
|
| 8200 | "sources": [
|
| 8201 | {
|
| 8202 | "fileName": "connect.ts",
|
| 8203 | "line": 69,
|
| 8204 | "character": 12
|
| 8205 | }
|
| 8206 | ],
|
| 8207 | "type": {
|
| 8208 | "type": "intersection",
|
| 8209 | "types": [
|
| 8210 | {
|
| 8211 | "type": "reference",
|
| 8212 | "id": 525,
|
| 8213 | "name": "RenderConfigScreenPropertiesAndMethods"
|
| 8214 | },
|
| 8215 | {
|
| 8216 | "type": "reference",
|
| 8217 | "id": 57,
|
| 8218 | "name": "SizingUtilities"
|
| 8219 | }
|
| 8220 | ]
|
| 8221 | }
|
| 8222 | },
|
| 8223 | {
|
| 8224 | "id": 524,
|
| 8225 | "name": "RenderConfigScreenMethods",
|
| 8226 | "kind": 4194304,
|
| 8227 | "kindString": "Type alias",
|
| 8228 | "flags": {},
|
| 8229 | "sources": [
|
| 8230 | {
|
| 8231 | "fileName": "types.ts",
|
| 8232 | "line": 1261,
|
| 8233 | "character": 12
|
| 8234 | }
|
| 8235 | ],
|
| 8236 | "type": {
|
| 8237 | "type": "intersection",
|
| 8238 | "types": [
|
| 8239 | {
|
| 8240 | "type": "reference",
|
| 8241 | "id": 397,
|
| 8242 | "name": "RenderMethods"
|
| 8243 | },
|
| 8244 | {
|
| 8245 | "type": "reference",
|
| 8246 | "id": 392,
|
| 8247 | "name": "IframeMethods"
|
| 8248 | },
|
| 8249 | {
|
| 8250 | "type": "reference",
|
| 8251 | "id": 520,
|
| 8252 | "name": "RenderConfigScreenAdditionalMethods"
|
| 8253 | }
|
| 8254 | ]
|
| 8255 | }
|
| 8256 | },
|
| 8257 | {
|
| 8258 | "id": 519,
|
| 8259 | "name": "RenderConfigScreenProperties",
|
| 8260 | "kind": 4194304,
|
| 8261 | "kindString": "Type alias",
|
| 8262 | "flags": {},
|
| 8263 | "sources": [
|
| 8264 | {
|
| 8265 | "fileName": "types.ts",
|
| 8266 | "line": 1253,
|
| 8267 | "character": 12
|
| 8268 | }
|
| 8269 | ],
|
| 8270 | "type": {
|
| 8271 | "type": "intersection",
|
| 8272 | "types": [
|
| 8273 | {
|
| 8274 | "type": "reference",
|
| 8275 | "id": 281,
|
| 8276 | "name": "RenderProperties"
|
| 8277 | },
|
| 8278 | {
|
| 8279 | "type": "reference",
|
| 8280 | "id": 516,
|
| 8281 | "name": "RenderConfigScreenAdditionalProperties"
|
| 8282 | }
|
| 8283 | ]
|
| 8284 | }
|
| 8285 | },
|
| 8286 | {
|
| 8287 | "id": 525,
|
| 8288 | "name": "RenderConfigScreenPropertiesAndMethods",
|
| 8289 | "kind": 4194304,
|
| 8290 | "kindString": "Type alias",
|
| 8291 | "flags": {},
|
| 8292 | "sources": [
|
| 8293 | {
|
| 8294 | "fileName": "types.ts",
|
| 8295 | "line": 1265,
|
| 8296 | "character": 12
|
| 8297 | }
|
| 8298 | ],
|
| 8299 | "type": {
|
| 8300 | "type": "intersection",
|
| 8301 | "types": [
|
| 8302 | {
|
| 8303 | "type": "reference",
|
| 8304 | "id": 524,
|
| 8305 | "name": "RenderConfigScreenMethods"
|
| 8306 | },
|
| 8307 | {
|
| 8308 | "type": "reference",
|
| 8309 | "id": 519,
|
| 8310 | "name": "RenderConfigScreenProperties"
|
| 8311 | }
|
| 8312 | ]
|
| 8313 | }
|
| 8314 | },
|
| 8315 | {
|
| 8316 | "id": 452,
|
| 8317 | "name": "RenderFieldExtensionAdditionalMethods",
|
| 8318 | "kind": 4194304,
|
| 8319 | "kindString": "Type alias",
|
| 8320 | "flags": {},
|
| 8321 | "sources": [
|
| 8322 | {
|
| 8323 | "fileName": "types.ts",
|
| 8324 | "line": 1111,
|
| 8325 | "character": 12
|
| 8326 | }
|
| 8327 | ],
|
| 8328 | "type": {
|
| 8329 | "type": "reflection",
|
| 8330 | "declaration": {
|
| 8331 | "id": 453,
|
| 8332 | "name": "__type",
|
| 8333 | "kind": 65536,
|
| 8334 | "kindString": "Type literal",
|
| 8335 | "flags": {},
|
| 8336 | "children": [
|
| 8337 | {
|
| 8338 | "id": 454,
|
| 8339 | "name": "getSettings",
|
| 8340 | "kind": 2048,
|
| 8341 | "kindString": "Method",
|
| 8342 | "flags": {},
|
| 8343 | "sources": [
|
| 8344 | {
|
| 8345 | "fileName": "types.ts",
|
| 8346 | "line": 1112,
|
| 8347 | "character": 2
|
| 8348 | }
|
| 8349 | ],
|
| 8350 | "signatures": [
|
| 8351 | {
|
| 8352 | "id": 455,
|
| 8353 | "name": "getSettings",
|
| 8354 | "kind": 4096,
|
| 8355 | "kindString": "Call signature",
|
| 8356 | "flags": {},
|
| 8357 | "type": {
|
| 8358 | "type": "reference",
|
| 8359 | "typeArguments": [
|
| 8360 | {
|
| 8361 | "type": "reference",
|
| 8362 | "id": 451,
|
| 8363 | "name": "RenderFieldExtensionProperties"
|
| 8364 | }
|
| 8365 | ],
|
| 8366 | "name": "Promise"
|
| 8367 | }
|
| 8368 | }
|
| 8369 | ]
|
| 8370 | }
|
| 8371 | ],
|
| 8372 | "groups": [
|
| 8373 | {
|
| 8374 | "title": "Methods",
|
| 8375 | "kind": 2048,
|
| 8376 | "children": [
|
| 8377 | 454
|
| 8378 | ]
|
| 8379 | }
|
| 8380 | ],
|
| 8381 | "sources": [
|
| 8382 | {
|
| 8383 | "fileName": "types.ts",
|
| 8384 | "line": 1111,
|
| 8385 | "character": 52
|
| 8386 | }
|
| 8387 | ]
|
| 8388 | }
|
| 8389 | }
|
| 8390 | },
|
| 8391 | {
|
| 8392 | "id": 441,
|
| 8393 | "name": "RenderFieldExtensionAdditionalProperties",
|
| 8394 | "kind": 4194304,
|
| 8395 | "kindString": "Type alias",
|
| 8396 | "flags": {},
|
| 8397 | "comment": {
|
| 8398 | "shortText": "Information regarding the state of a specific field where you need to render\nthe field extension"
|
| 8399 | },
|
| 8400 | "sources": [
|
| 8401 | {
|
| 8402 | "fileName": "types.ts",
|
| 8403 | "line": 1087,
|
| 8404 | "character": 12
|
| 8405 | }
|
| 8406 | ],
|
| 8407 | "type": {
|
| 8408 | "type": "reflection",
|
| 8409 | "declaration": {
|
| 8410 | "id": 442,
|
| 8411 | "name": "__type",
|
| 8412 | "kind": 65536,
|
| 8413 | "kindString": "Type literal",
|
| 8414 | "flags": {},
|
| 8415 | "children": [
|
| 8416 | {
|
| 8417 | "id": 447,
|
| 8418 | "name": "disabled",
|
| 8419 | "kind": 1024,
|
| 8420 | "kindString": "Property",
|
| 8421 | "flags": {},
|
| 8422 | "comment": {
|
| 8423 | "shortText": "Whether the field is currently disabled or not"
|
| 8424 | },
|
| 8425 | "sources": [
|
| 8426 | {
|
| 8427 | "fileName": "types.ts",
|
| 8428 | "line": 1096,
|
| 8429 | "character": 2
|
| 8430 | }
|
| 8431 | ],
|
| 8432 | "type": {
|
| 8433 | "type": "intrinsic",
|
| 8434 | "name": "boolean"
|
| 8435 | }
|
| 8436 | },
|
| 8437 | {
|
| 8438 | "id": 449,
|
| 8439 | "name": "field",
|
| 8440 | "kind": 1024,
|
| 8441 | "kindString": "Property",
|
| 8442 | "flags": {},
|
| 8443 | "comment": {
|
| 8444 | "shortText": "The field where the field extension is installed to"
|
| 8445 | },
|
| 8446 | "sources": [
|
| 8447 | {
|
| 8448 | "fileName": "types.ts",
|
| 8449 | "line": 1100,
|
| 8450 | "character": 2
|
| 8451 | }
|
| 8452 | ],
|
| 8453 | "type": {
|
| 8454 | "type": "reference",
|
| 8455 | "id": 5,
|
| 8456 | "name": "Field"
|
| 8457 | }
|
| 8458 | },
|
| 8459 | {
|
| 8460 | "id": 444,
|
| 8461 | "name": "fieldExtensionId",
|
| 8462 | "kind": 1024,
|
| 8463 | "kindString": "Property",
|
| 8464 | "flags": {},
|
| 8465 | "comment": {
|
| 8466 | "shortText": "The ID of the field extension that needs to be rendered"
|
| 8467 | },
|
| 8468 | "sources": [
|
| 8469 | {
|
| 8470 | "fileName": "types.ts",
|
| 8471 | "line": 1090,
|
| 8472 | "character": 2
|
| 8473 | }
|
| 8474 | ],
|
| 8475 | "type": {
|
| 8476 | "type": "intrinsic",
|
| 8477 | "name": "string"
|
| 8478 | }
|
| 8479 | },
|
| 8480 | {
|
| 8481 | "id": 448,
|
| 8482 | "name": "fieldPath",
|
| 8483 | "kind": 1024,
|
| 8484 | "kindString": "Property",
|
| 8485 | "flags": {},
|
| 8486 | "comment": {
|
| 8487 | "shortText": "The path in the `formValues` object where to find the current value for the field"
|
| 8488 | },
|
| 8489 | "sources": [
|
| 8490 | {
|
| 8491 | "fileName": "types.ts",
|
| 8492 | "line": 1098,
|
| 8493 | "character": 2
|
| 8494 | }
|
| 8495 | ],
|
| 8496 | "type": {
|
| 8497 | "type": "intrinsic",
|
| 8498 | "name": "string"
|
| 8499 | }
|
| 8500 | },
|
| 8501 | {
|
| 8502 | "id": 443,
|
| 8503 | "name": "mode",
|
| 8504 | "kind": 1024,
|
| 8505 | "kindString": "Property",
|
| 8506 | "flags": {},
|
| 8507 | "sources": [
|
| 8508 | {
|
| 8509 | "fileName": "types.ts",
|
| 8510 | "line": 1088,
|
| 8511 | "character": 2
|
| 8512 | }
|
| 8513 | ],
|
| 8514 | "type": {
|
| 8515 | "type": "literal",
|
| 8516 | "value": "renderFieldExtension"
|
| 8517 | }
|
| 8518 | },
|
| 8519 | {
|
| 8520 | "id": 445,
|
| 8521 | "name": "parameters",
|
| 8522 | "kind": 1024,
|
| 8523 | "kindString": "Property",
|
| 8524 | "flags": {},
|
| 8525 | "comment": {
|
| 8526 | "shortText": "The arbitrary `parameters` of the field extension"
|
| 8527 | },
|
| 8528 | "sources": [
|
| 8529 | {
|
| 8530 | "fileName": "types.ts",
|
| 8531 | "line": 1092,
|
| 8532 | "character": 2
|
| 8533 | }
|
| 8534 | ],
|
| 8535 | "type": {
|
| 8536 | "type": "reference",
|
| 8537 | "typeArguments": [
|
| 8538 | {
|
| 8539 | "type": "intrinsic",
|
| 8540 | "name": "string"
|
| 8541 | },
|
| 8542 | {
|
| 8543 | "type": "intrinsic",
|
| 8544 | "name": "unknown"
|
| 8545 | }
|
| 8546 | ],
|
| 8547 | "name": "Record"
|
| 8548 | }
|
| 8549 | },
|
| 8550 | {
|
| 8551 | "id": 450,
|
| 8552 | "name": "parentField",
|
| 8553 | "kind": 1024,
|
| 8554 | "kindString": "Property",
|
| 8555 | "flags": {},
|
| 8556 | "comment": {
|
| 8557 | "shortText": "If the field extension is installed in a field of a block, returns the top\nlevel Modular Content/Structured Text field containing the block itself"
|
| 8558 | },
|
| 8559 | "sources": [
|
| 8560 | {
|
| 8561 | "fileName": "types.ts",
|
| 8562 | "line": 1105,
|
| 8563 | "character": 2
|
| 8564 | }
|
| 8565 | ],
|
| 8566 | "type": {
|
| 8567 | "type": "union",
|
| 8568 | "types": [
|
| 8569 | {
|
| 8570 | "type": "reference",
|
| 8571 | "id": 5,
|
| 8572 | "name": "Field"
|
| 8573 | },
|
| 8574 | {
|
| 8575 | "type": "intrinsic",
|
| 8576 | "name": "undefined"
|
| 8577 | }
|
| 8578 | ]
|
| 8579 | }
|
| 8580 | },
|
| 8581 | {
|
| 8582 | "id": 446,
|
| 8583 | "name": "placeholder",
|
| 8584 | "kind": 1024,
|
| 8585 | "kindString": "Property",
|
| 8586 | "flags": {},
|
| 8587 | "comment": {
|
| 8588 | "shortText": "The placeholder for the field"
|
| 8589 | },
|
| 8590 | "sources": [
|
| 8591 | {
|
| 8592 | "fileName": "types.ts",
|
| 8593 | "line": 1094,
|
| 8594 | "character": 2
|
| 8595 | }
|
| 8596 | ],
|
| 8597 | "type": {
|
| 8598 | "type": "intrinsic",
|
| 8599 | "name": "string"
|
| 8600 | }
|
| 8601 | }
|
| 8602 | ],
|
| 8603 | "groups": [
|
| 8604 | {
|
| 8605 | "title": "Properties",
|
| 8606 | "kind": 1024,
|
| 8607 | "children": [
|
| 8608 | 447,
|
| 8609 | 449,
|
| 8610 | 444,
|
| 8611 | 448,
|
| 8612 | 443,
|
| 8613 | 445,
|
| 8614 | 450,
|
| 8615 | 446
|
| 8616 | ]
|
| 8617 | }
|
| 8618 | ],
|
| 8619 | "sources": [
|
| 8620 | {
|
| 8621 | "fileName": "types.ts",
|
| 8622 | "line": 1087,
|
| 8623 | "character": 55
|
| 8624 | }
|
| 8625 | ]
|
| 8626 | }
|
| 8627 | }
|
| 8628 | },
|
| 8629 | {
|
| 8630 | "id": 74,
|
| 8631 | "name": "RenderFieldExtensionCtx",
|
| 8632 | "kind": 4194304,
|
| 8633 | "kindString": "Type alias",
|
| 8634 | "flags": {},
|
| 8635 | "sources": [
|
| 8636 | {
|
| 8637 | "fileName": "connect.ts",
|
| 8638 | "line": 65,
|
| 8639 | "character": 12
|
| 8640 | }
|
| 8641 | ],
|
| 8642 | "type": {
|
| 8643 | "type": "intersection",
|
| 8644 | "types": [
|
| 8645 | {
|
| 8646 | "type": "reference",
|
| 8647 | "id": 457,
|
| 8648 | "name": "RenderFieldExtensionPropertiesAndMethods"
|
| 8649 | },
|
| 8650 | {
|
| 8651 | "type": "reference",
|
| 8652 | "id": 57,
|
| 8653 | "name": "SizingUtilities"
|
| 8654 | }
|
| 8655 | ]
|
| 8656 | }
|
| 8657 | },
|
| 8658 | {
|
| 8659 | "id": 456,
|
| 8660 | "name": "RenderFieldExtensionMethods",
|
| 8661 | "kind": 4194304,
|
| 8662 | "kindString": "Type alias",
|
| 8663 | "flags": {},
|
| 8664 | "sources": [
|
| 8665 | {
|
| 8666 | "fileName": "types.ts",
|
| 8667 | "line": 1115,
|
| 8668 | "character": 12
|
| 8669 | }
|
| 8670 | ],
|
| 8671 | "type": {
|
| 8672 | "type": "intersection",
|
| 8673 | "types": [
|
| 8674 | {
|
| 8675 | "type": "reference",
|
| 8676 | "id": 428,
|
| 8677 | "name": "ItemFormMethods"
|
| 8678 | },
|
| 8679 | {
|
| 8680 | "type": "reference",
|
| 8681 | "id": 452,
|
| 8682 | "name": "RenderFieldExtensionAdditionalMethods"
|
| 8683 | }
|
| 8684 | ]
|
| 8685 | }
|
| 8686 | },
|
| 8687 | {
|
| 8688 | "id": 451,
|
| 8689 | "name": "RenderFieldExtensionProperties",
|
| 8690 | "kind": 4194304,
|
| 8691 | "kindString": "Type alias",
|
| 8692 | "flags": {},
|
| 8693 | "sources": [
|
| 8694 | {
|
| 8695 | "fileName": "types.ts",
|
| 8696 | "line": 1108,
|
| 8697 | "character": 12
|
| 8698 | }
|
| 8699 | ],
|
| 8700 | "type": {
|
| 8701 | "type": "intersection",
|
| 8702 | "types": [
|
| 8703 | {
|
| 8704 | "type": "reference",
|
| 8705 | "id": 407,
|
| 8706 | "name": "ItemFormProperties"
|
| 8707 | },
|
| 8708 | {
|
| 8709 | "type": "reference",
|
| 8710 | "id": 441,
|
| 8711 | "name": "RenderFieldExtensionAdditionalProperties"
|
| 8712 | }
|
| 8713 | ]
|
| 8714 | }
|
| 8715 | },
|
| 8716 | {
|
| 8717 | "id": 457,
|
| 8718 | "name": "RenderFieldExtensionPropertiesAndMethods",
|
| 8719 | "kind": 4194304,
|
| 8720 | "kindString": "Type alias",
|
| 8721 | "flags": {},
|
| 8722 | "sources": [
|
| 8723 | {
|
| 8724 | "fileName": "types.ts",
|
| 8725 | "line": 1118,
|
| 8726 | "character": 12
|
| 8727 | }
|
| 8728 | ],
|
| 8729 | "type": {
|
| 8730 | "type": "intersection",
|
| 8731 | "types": [
|
| 8732 | {
|
| 8733 | "type": "reference",
|
| 8734 | "id": 456,
|
| 8735 | "name": "RenderFieldExtensionMethods"
|
| 8736 | },
|
| 8737 | {
|
| 8738 | "type": "reference",
|
| 8739 | "id": 451,
|
| 8740 | "name": "RenderFieldExtensionProperties"
|
| 8741 | }
|
| 8742 | ]
|
| 8743 | }
|
| 8744 | },
|
| 8745 | {
|
| 8746 | "id": 73,
|
| 8747 | "name": "RenderItemFormSidebarPanelCtx",
|
| 8748 | "kind": 4194304,
|
| 8749 | "kindString": "Type alias",
|
| 8750 | "flags": {},
|
| 8751 | "sources": [
|
| 8752 | {
|
| 8753 | "fileName": "connect.ts",
|
| 8754 | "line": 63,
|
| 8755 | "character": 12
|
| 8756 | }
|
| 8757 | ],
|
| 8758 | "type": {
|
| 8759 | "type": "intersection",
|
| 8760 | "types": [
|
| 8761 | {
|
| 8762 | "type": "reference",
|
| 8763 | "id": 440,
|
| 8764 | "name": "RenderSidebarPanePropertiesAndMethods"
|
| 8765 | },
|
| 8766 | {
|
| 8767 | "type": "reference",
|
| 8768 | "id": 57,
|
| 8769 | "name": "SizingUtilities"
|
| 8770 | }
|
| 8771 | ]
|
| 8772 | }
|
| 8773 | },
|
| 8774 | {
|
| 8775 | "id": 507,
|
| 8776 | "name": "RenderManualFieldExtensionConfigScreenAdditionalMethods",
|
| 8777 | "kind": 4194304,
|
| 8778 | "kindString": "Type alias",
|
| 8779 | "flags": {},
|
| 8780 | "comment": {
|
| 8781 | "shortText": "These methods can be used to update the configuration object of a specific\nfield extension"
|
| 8782 | },
|
| 8783 | "sources": [
|
| 8784 | {
|
| 8785 | "fileName": "types.ts",
|
| 8786 | "line": 1228,
|
| 8787 | "character": 12
|
| 8788 | }
|
| 8789 | ],
|
| 8790 | "type": {
|
| 8791 | "type": "reflection",
|
| 8792 | "declaration": {
|
| 8793 | "id": 508,
|
| 8794 | "name": "__type",
|
| 8795 | "kind": 65536,
|
| 8796 | "kindString": "Type literal",
|
| 8797 | "flags": {},
|
| 8798 | "children": [
|
| 8799 | {
|
| 8800 | "id": 509,
|
| 8801 | "name": "getSettings",
|
| 8802 | "kind": 2048,
|
| 8803 | "kindString": "Method",
|
| 8804 | "flags": {},
|
| 8805 | "sources": [
|
| 8806 | {
|
| 8807 | "fileName": "types.ts",
|
| 8808 | "line": 1229,
|
| 8809 | "character": 2
|
| 8810 | }
|
| 8811 | ],
|
| 8812 | "signatures": [
|
| 8813 | {
|
| 8814 | "id": 510,
|
| 8815 | "name": "getSettings",
|
| 8816 | "kind": 4096,
|
| 8817 | "kindString": "Call signature",
|
| 8818 | "flags": {},
|
| 8819 | "type": {
|
| 8820 | "type": "reference",
|
| 8821 | "typeArguments": [
|
| 8822 | {
|
| 8823 | "type": "reference",
|
| 8824 | "id": 506,
|
| 8825 | "name": "RenderManualFieldExtensionConfigScreenProperties"
|
| 8826 | }
|
| 8827 | ],
|
| 8828 | "name": "Promise"
|
| 8829 | }
|
| 8830 | }
|
| 8831 | ]
|
| 8832 | },
|
| 8833 | {
|
| 8834 | "id": 511,
|
| 8835 | "name": "setParameters",
|
| 8836 | "kind": 2048,
|
| 8837 | "kindString": "Method",
|
| 8838 | "flags": {},
|
| 8839 | "sources": [
|
| 8840 | {
|
| 8841 | "fileName": "types.ts",
|
| 8842 | "line": 1239,
|
| 8843 | "character": 2
|
| 8844 | }
|
| 8845 | ],
|
| 8846 | "signatures": [
|
| 8847 | {
|
| 8848 | "id": 512,
|
| 8849 | "name": "setParameters",
|
| 8850 | "kind": 4096,
|
| 8851 | "kindString": "Call signature",
|
| 8852 | "flags": {},
|
| 8853 | "comment": {
|
| 8854 | "shortText": "Sets a new value for the parameters",
|
| 8855 | "tags": [
|
| 8856 | {
|
| 8857 | "tag": "example",
|
| 8858 | "text": "\n\n```js\nawait ctx.setParameters({ color: '#ff0000' });\n```\n"
|
| 8859 | }
|
| 8860 | ]
|
| 8861 | },
|
| 8862 | "parameters": [
|
| 8863 | {
|
| 8864 | "id": 513,
|
| 8865 | "name": "params",
|
| 8866 | "kind": 32768,
|
| 8867 | "kindString": "Parameter",
|
| 8868 | "flags": {},
|
| 8869 | "type": {
|
| 8870 | "type": "reference",
|
| 8871 | "typeArguments": [
|
| 8872 | {
|
| 8873 | "type": "intrinsic",
|
| 8874 | "name": "string"
|
| 8875 | },
|
| 8876 | {
|
| 8877 | "type": "intrinsic",
|
| 8878 | "name": "unknown"
|
| 8879 | }
|
| 8880 | ],
|
| 8881 | "name": "Record"
|
| 8882 | }
|
| 8883 | }
|
| 8884 | ],
|
| 8885 | "type": {
|
| 8886 | "type": "reference",
|
| 8887 | "typeArguments": [
|
| 8888 | {
|
| 8889 | "type": "intrinsic",
|
| 8890 | "name": "void"
|
| 8891 | }
|
| 8892 | ],
|
| 8893 | "name": "Promise"
|
| 8894 | }
|
| 8895 | }
|
| 8896 | ]
|
| 8897 | }
|
| 8898 | ],
|
| 8899 | "groups": [
|
| 8900 | {
|
| 8901 | "title": "Methods",
|
| 8902 | "kind": 2048,
|
| 8903 | "children": [
|
| 8904 | 509,
|
| 8905 | 511
|
| 8906 | ]
|
| 8907 | }
|
| 8908 | ],
|
| 8909 | "sources": [
|
| 8910 | {
|
| 8911 | "fileName": "types.ts",
|
| 8912 | "line": 1228,
|
| 8913 | "character": 70
|
| 8914 | }
|
| 8915 | ]
|
| 8916 | }
|
| 8917 | }
|
| 8918 | },
|
| 8919 | {
|
| 8920 | "id": 498,
|
| 8921 | "name": "RenderManualFieldExtensionConfigScreenAdditionalProperties",
|
| 8922 | "kind": 4194304,
|
| 8923 | "kindString": "Type alias",
|
| 8924 | "flags": {},
|
| 8925 | "comment": {
|
| 8926 | "shortText": "Information regarding the specific form that you need to render to let the\nend-user edit the configuration object of a field extension"
|
| 8927 | },
|
| 8928 | "sources": [
|
| 8929 | {
|
| 8930 | "fileName": "types.ts",
|
| 8931 | "line": 1199,
|
| 8932 | "character": 12
|
| 8933 | }
|
| 8934 | ],
|
| 8935 | "type": {
|
| 8936 | "type": "reflection",
|
| 8937 | "declaration": {
|
| 8938 | "id": 499,
|
| 8939 | "name": "__type",
|
| 8940 | "kind": 65536,
|
| 8941 | "kindString": "Type literal",
|
| 8942 | "flags": {},
|
| 8943 | "children": [
|
| 8944 | {
|
| 8945 | "id": 503,
|
| 8946 | "name": "errors",
|
| 8947 | "kind": 1024,
|
| 8948 | "kindString": "Property",
|
| 8949 | "flags": {},
|
| 8950 | "comment": {
|
| 8951 | "shortText": "The current validation errors for the parameters (you can set them\nimplementing the `validateManualFieldExtensionParameters` function)"
|
| 8952 | },
|
| 8953 | "sources": [
|
| 8954 | {
|
| 8955 | "fileName": "types.ts",
|
| 8956 | "line": 1212,
|
| 8957 | "character": 2
|
| 8958 | }
|
| 8959 | ],
|
| 8960 | "type": {
|
| 8961 | "type": "reference",
|
| 8962 | "typeArguments": [
|
| 8963 | {
|
| 8964 | "type": "intrinsic",
|
| 8965 | "name": "string"
|
| 8966 | },
|
| 8967 | {
|
| 8968 | "type": "intrinsic",
|
| 8969 | "name": "unknown"
|
| 8970 | }
|
| 8971 | ],
|
| 8972 | "name": "Record"
|
| 8973 | }
|
| 8974 | },
|
| 8975 | {
|
| 8976 | "id": 501,
|
| 8977 | "name": "fieldExtensionId",
|
| 8978 | "kind": 1024,
|
| 8979 | "kindString": "Property",
|
| 8980 | "flags": {},
|
| 8981 | "comment": {
|
| 8982 | "shortText": "The ID of the field extension for which we need to render the parameters form"
|
| 8983 | },
|
| 8984 | "sources": [
|
| 8985 | {
|
| 8986 | "fileName": "types.ts",
|
| 8987 | "line": 1202,
|
| 8988 | "character": 2
|
| 8989 | }
|
| 8990 | ],
|
| 8991 | "type": {
|
| 8992 | "type": "intrinsic",
|
| 8993 | "name": "string"
|
| 8994 | }
|
| 8995 | },
|
| 8996 | {
|
| 8997 | "id": 505,
|
| 8998 | "name": "itemType",
|
| 8999 | "kind": 1024,
|
| 9000 | "kindString": "Property",
|
| 9001 | "flags": {},
|
| 9002 | "comment": {
|
| 9003 | "shortText": "The model for the field being edited"
|
| 9004 | },
|
| 9005 | "sources": [
|
| 9006 | {
|
| 9007 | "fileName": "types.ts",
|
| 9008 | "line": 1218,
|
| 9009 | "character": 2
|
| 9010 | }
|
| 9011 | ],
|
| 9012 | "type": {
|
| 9013 | "type": "reference",
|
| 9014 | "id": 16,
|
| 9015 | "name": "ModelBlock"
|
| 9016 | }
|
| 9017 | },
|
| 9018 | {
|
| 9019 | "id": 500,
|
| 9020 | "name": "mode",
|
| 9021 | "kind": 1024,
|
| 9022 | "kindString": "Property",
|
| 9023 | "flags": {},
|
| 9024 | "sources": [
|
| 9025 | {
|
| 9026 | "fileName": "types.ts",
|
| 9027 | "line": 1200,
|
| 9028 | "character": 2
|
| 9029 | }
|
| 9030 | ],
|
| 9031 | "type": {
|
| 9032 | "type": "literal",
|
| 9033 | "value": "renderManualFieldExtensionConfigScreen"
|
| 9034 | }
|
| 9035 | },
|
| 9036 | {
|
| 9037 | "id": 502,
|
| 9038 | "name": "parameters",
|
| 9039 | "kind": 1024,
|
| 9040 | "kindString": "Property",
|
| 9041 | "flags": {},
|
| 9042 | "comment": {
|
| 9043 | "shortText": "The current value of the parameters (you can change the value with the\n`setParameters` function)"
|
| 9044 | },
|
| 9045 | "sources": [
|
| 9046 | {
|
| 9047 | "fileName": "types.ts",
|
| 9048 | "line": 1207,
|
| 9049 | "character": 2
|
| 9050 | }
|
| 9051 | ],
|
| 9052 | "type": {
|
| 9053 | "type": "reference",
|
| 9054 | "typeArguments": [
|
| 9055 | {
|
| 9056 | "type": "intrinsic",
|
| 9057 | "name": "string"
|
| 9058 | },
|
| 9059 | {
|
| 9060 | "type": "intrinsic",
|
| 9061 | "name": "unknown"
|
| 9062 | }
|
| 9063 | ],
|
| 9064 | "name": "Record"
|
| 9065 | }
|
| 9066 | },
|
| 9067 | {
|
| 9068 | "id": 504,
|
| 9069 | "name": "pendingField",
|
| 9070 | "kind": 1024,
|
| 9071 | "kindString": "Property",
|
| 9072 | "flags": {},
|
| 9073 | "comment": {
|
| 9074 | "shortText": "The field entity that is being edited in the form"
|
| 9075 | },
|
| 9076 | "sources": [
|
| 9077 | {
|
| 9078 | "fileName": "types.ts",
|
| 9079 | "line": 1215,
|
| 9080 | "character": 2
|
| 9081 | }
|
| 9082 | ],
|
| 9083 | "type": {
|
| 9084 | "type": "reference",
|
| 9085 | "id": 484,
|
| 9086 | "name": "PendingField"
|
| 9087 | }
|
| 9088 | }
|
| 9089 | ],
|
| 9090 | "groups": [
|
| 9091 | {
|
| 9092 | "title": "Properties",
|
| 9093 | "kind": 1024,
|
| 9094 | "children": [
|
| 9095 | 503,
|
| 9096 | 501,
|
| 9097 | 505,
|
| 9098 | 500,
|
| 9099 | 502,
|
| 9100 | 504
|
| 9101 | ]
|
| 9102 | }
|
| 9103 | ],
|
| 9104 | "sources": [
|
| 9105 | {
|
| 9106 | "fileName": "types.ts",
|
| 9107 | "line": 1199,
|
| 9108 | "character": 73
|
| 9109 | }
|
| 9110 | ]
|
| 9111 | }
|
| 9112 | }
|
| 9113 | },
|
| 9114 | {
|
| 9115 | "id": 75,
|
| 9116 | "name": "RenderManualFieldExtensionConfigScreenCtx",
|
| 9117 | "kind": 4194304,
|
| 9118 | "kindString": "Type alias",
|
| 9119 | "flags": {},
|
| 9120 | "sources": [
|
| 9121 | {
|
| 9122 | "fileName": "connect.ts",
|
| 9123 | "line": 67,
|
| 9124 | "character": 12
|
| 9125 | }
|
| 9126 | ],
|
| 9127 | "type": {
|
| 9128 | "type": "intersection",
|
| 9129 | "types": [
|
| 9130 | {
|
| 9131 | "type": "reference",
|
| 9132 | "id": 515,
|
| 9133 | "name": "RenderManualFieldExtensionConfigScreenPropertiesAndMethods"
|
| 9134 | },
|
| 9135 | {
|
| 9136 | "type": "reference",
|
| 9137 | "id": 57,
|
| 9138 | "name": "SizingUtilities"
|
| 9139 | }
|
| 9140 | ]
|
| 9141 | }
|
| 9142 | },
|
| 9143 | {
|
| 9144 | "id": 514,
|
| 9145 | "name": "RenderManualFieldExtensionConfigScreenMethods",
|
| 9146 | "kind": 4194304,
|
| 9147 | "kindString": "Type alias",
|
| 9148 | "flags": {},
|
| 9149 | "sources": [
|
| 9150 | {
|
| 9151 | "fileName": "types.ts",
|
| 9152 | "line": 1242,
|
| 9153 | "character": 12
|
| 9154 | }
|
| 9155 | ],
|
| 9156 | "type": {
|
| 9157 | "type": "intersection",
|
| 9158 | "types": [
|
| 9159 | {
|
| 9160 | "type": "reference",
|
| 9161 | "id": 397,
|
| 9162 | "name": "RenderMethods"
|
| 9163 | },
|
| 9164 | {
|
| 9165 | "type": "reference",
|
| 9166 | "id": 392,
|
| 9167 | "name": "IframeMethods"
|
| 9168 | },
|
| 9169 | {
|
| 9170 | "type": "reference",
|
| 9171 | "id": 507,
|
| 9172 | "name": "RenderManualFieldExtensionConfigScreenAdditionalMethods"
|
| 9173 | }
|
| 9174 | ]
|
| 9175 | }
|
| 9176 | },
|
| 9177 | {
|
| 9178 | "id": 506,
|
| 9179 | "name": "RenderManualFieldExtensionConfigScreenProperties",
|
| 9180 | "kind": 4194304,
|
| 9181 | "kindString": "Type alias",
|
| 9182 | "flags": {},
|
| 9183 | "sources": [
|
| 9184 | {
|
| 9185 | "fileName": "types.ts",
|
| 9186 | "line": 1221,
|
| 9187 | "character": 12
|
| 9188 | }
|
| 9189 | ],
|
| 9190 | "type": {
|
| 9191 | "type": "intersection",
|
| 9192 | "types": [
|
| 9193 | {
|
| 9194 | "type": "reference",
|
| 9195 | "id": 281,
|
| 9196 | "name": "RenderProperties"
|
| 9197 | },
|
| 9198 | {
|
| 9199 | "type": "reference",
|
| 9200 | "id": 498,
|
| 9201 | "name": "RenderManualFieldExtensionConfigScreenAdditionalProperties"
|
| 9202 | }
|
| 9203 | ]
|
| 9204 | }
|
| 9205 | },
|
| 9206 | {
|
| 9207 | "id": 515,
|
| 9208 | "name": "RenderManualFieldExtensionConfigScreenPropertiesAndMethods",
|
| 9209 | "kind": 4194304,
|
| 9210 | "kindString": "Type alias",
|
| 9211 | "flags": {},
|
| 9212 | "sources": [
|
| 9213 | {
|
| 9214 | "fileName": "types.ts",
|
| 9215 | "line": 1246,
|
| 9216 | "character": 12
|
| 9217 | }
|
| 9218 | ],
|
| 9219 | "type": {
|
| 9220 | "type": "intersection",
|
| 9221 | "types": [
|
| 9222 | {
|
| 9223 | "type": "reference",
|
| 9224 | "id": 514,
|
| 9225 | "name": "RenderManualFieldExtensionConfigScreenMethods"
|
| 9226 | },
|
| 9227 | {
|
| 9228 | "type": "reference",
|
| 9229 | "id": 506,
|
| 9230 | "name": "RenderManualFieldExtensionConfigScreenProperties"
|
| 9231 | }
|
| 9232 | ]
|
| 9233 | }
|
| 9234 | },
|
| 9235 | {
|
| 9236 | "id": 397,
|
| 9237 | "name": "RenderMethods",
|
| 9238 | "kind": 4194304,
|
| 9239 | "kindString": "Type alias",
|
| 9240 | "flags": {},
|
| 9241 | "sources": [
|
| 9242 | {
|
| 9243 | "fileName": "types.ts",
|
| 9244 | "line": 946,
|
| 9245 | "character": 12
|
| 9246 | }
|
| 9247 | ],
|
| 9248 | "type": {
|
| 9249 | "type": "intersection",
|
| 9250 | "types": [
|
| 9251 | {
|
| 9252 | "type": "reference",
|
| 9253 | "id": 315,
|
| 9254 | "name": "LoadDataMethods"
|
| 9255 | },
|
| 9256 | {
|
| 9257 | "type": "reference",
|
| 9258 | "id": 306,
|
| 9259 | "name": "UpdateParametersMethods"
|
| 9260 | },
|
| 9261 | {
|
| 9262 | "type": "reference",
|
| 9263 | "id": 346,
|
| 9264 | "name": "ToastMethods"
|
| 9265 | },
|
| 9266 | {
|
| 9267 | "type": "reference",
|
| 9268 | "id": 379,
|
| 9269 | "name": "CustomDialogMethods"
|
| 9270 | },
|
| 9271 | {
|
| 9272 | "type": "reference",
|
| 9273 | "id": 387,
|
| 9274 | "name": "NavigateMethods"
|
| 9275 | }
|
| 9276 | ]
|
| 9277 | }
|
| 9278 | },
|
| 9279 | {
|
| 9280 | "id": 464,
|
| 9281 | "name": "RenderModalAdditionalMethods",
|
| 9282 | "kind": 4194304,
|
| 9283 | "kindString": "Type alias",
|
| 9284 | "flags": {},
|
| 9285 | "comment": {
|
| 9286 | "shortText": "These methods can be used to close the modal"
|
| 9287 | },
|
| 9288 | "sources": [
|
| 9289 | {
|
| 9290 | "fileName": "types.ts",
|
| 9291 | "line": 1134,
|
| 9292 | "character": 12
|
| 9293 | }
|
| 9294 | ],
|
| 9295 | "type": {
|
| 9296 | "type": "reflection",
|
| 9297 | "declaration": {
|
| 9298 | "id": 465,
|
| 9299 | "name": "__type",
|
| 9300 | "kind": 65536,
|
| 9301 | "kindString": "Type literal",
|
| 9302 | "flags": {},
|
| 9303 | "children": [
|
| 9304 | {
|
| 9305 | "id": 466,
|
| 9306 | "name": "getSettings",
|
| 9307 | "kind": 2048,
|
| 9308 | "kindString": "Method",
|
| 9309 | "flags": {},
|
| 9310 | "sources": [
|
| 9311 | {
|
| 9312 | "fileName": "types.ts",
|
| 9313 | "line": 1135,
|
| 9314 | "character": 2
|
| 9315 | }
|
| 9316 | ],
|
| 9317 | "signatures": [
|
| 9318 | {
|
| 9319 | "id": 467,
|
| 9320 | "name": "getSettings",
|
| 9321 | "kind": 4096,
|
| 9322 | "kindString": "Call signature",
|
| 9323 | "flags": {},
|
| 9324 | "type": {
|
| 9325 | "type": "reference",
|
| 9326 | "typeArguments": [
|
| 9327 | {
|
| 9328 | "type": "reference",
|
| 9329 | "id": 463,
|
| 9330 | "name": "RenderModalProperties"
|
| 9331 | }
|
| 9332 | ],
|
| 9333 | "name": "Promise"
|
| 9334 | }
|
| 9335 | }
|
| 9336 | ]
|
| 9337 | },
|
| 9338 | {
|
| 9339 | "id": 468,
|
| 9340 | "name": "resolve",
|
| 9341 | "kind": 2048,
|
| 9342 | "kindString": "Method",
|
| 9343 | "flags": {},
|
| 9344 | "sources": [
|
| 9345 | {
|
| 9346 | "fileName": "types.ts",
|
| 9347 | "line": 1151,
|
| 9348 | "character": 2
|
| 9349 | }
|
| 9350 | ],
|
| 9351 | "signatures": [
|
| 9352 | {
|
| 9353 | "id": 469,
|
| 9354 | "name": "resolve",
|
| 9355 | "kind": 4096,
|
| 9356 | "kindString": "Call signature",
|
| 9357 | "flags": {},
|
| 9358 | "comment": {
|
| 9359 | "shortText": "A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value",
|
| 9360 | "tags": [
|
| 9361 | {
|
| 9362 | "tag": "example",
|
| 9363 | "text": "\n\n```js\nconst returnValue = prompt(\n 'Please specify the value to return to the caller:',\n 'success',\n);\n\nawait ctx.resolve(returnValue);\n```\n"
|
| 9364 | }
|
| 9365 | ]
|
| 9366 | },
|
| 9367 | "parameters": [
|
| 9368 | {
|
| 9369 | "id": 470,
|
| 9370 | "name": "returnValue",
|
| 9371 | "kind": 32768,
|
| 9372 | "kindString": "Parameter",
|
| 9373 | "flags": {},
|
| 9374 | "type": {
|
| 9375 | "type": "intrinsic",
|
| 9376 | "name": "unknown"
|
| 9377 | }
|
| 9378 | }
|
| 9379 | ],
|
| 9380 | "type": {
|
| 9381 | "type": "reference",
|
| 9382 | "typeArguments": [
|
| 9383 | {
|
| 9384 | "type": "intrinsic",
|
| 9385 | "name": "void"
|
| 9386 | }
|
| 9387 | ],
|
| 9388 | "name": "Promise"
|
| 9389 | }
|
| 9390 | }
|
| 9391 | ]
|
| 9392 | }
|
| 9393 | ],
|
| 9394 | "groups": [
|
| 9395 | {
|
| 9396 | "title": "Methods",
|
| 9397 | "kind": 2048,
|
| 9398 | "children": [
|
| 9399 | 466,
|
| 9400 | 468
|
| 9401 | ]
|
| 9402 | }
|
| 9403 | ],
|
| 9404 | "sources": [
|
| 9405 | {
|
| 9406 | "fileName": "types.ts",
|
| 9407 | "line": 1134,
|
| 9408 | "character": 43
|
| 9409 | }
|
| 9410 | ]
|
| 9411 | }
|
| 9412 | }
|
| 9413 | },
|
| 9414 | {
|
| 9415 | "id": 458,
|
| 9416 | "name": "RenderModalAdditionalProperties",
|
| 9417 | "kind": 4194304,
|
| 9418 | "kindString": "Type alias",
|
| 9419 | "flags": {},
|
| 9420 | "comment": {
|
| 9421 | "shortText": "Information regarding the specific custom modal that you need to render"
|
| 9422 | },
|
| 9423 | "sources": [
|
| 9424 | {
|
| 9425 | "fileName": "types.ts",
|
| 9426 | "line": 1122,
|
| 9427 | "character": 12
|
| 9428 | }
|
| 9429 | ],
|
| 9430 | "type": {
|
| 9431 | "type": "reflection",
|
| 9432 | "declaration": {
|
| 9433 | "id": 459,
|
| 9434 | "name": "__type",
|
| 9435 | "kind": 65536,
|
| 9436 | "kindString": "Type literal",
|
| 9437 | "flags": {},
|
| 9438 | "children": [
|
| 9439 | {
|
| 9440 | "id": 461,
|
| 9441 | "name": "modalId",
|
| 9442 | "kind": 1024,
|
| 9443 | "kindString": "Property",
|
| 9444 | "flags": {},
|
| 9445 | "comment": {
|
| 9446 | "shortText": "The ID of the modal that needs to be rendered"
|
| 9447 | },
|
| 9448 | "sources": [
|
| 9449 | {
|
| 9450 | "fileName": "types.ts",
|
| 9451 | "line": 1125,
|
| 9452 | "character": 2
|
| 9453 | }
|
| 9454 | ],
|
| 9455 | "type": {
|
| 9456 | "type": "intrinsic",
|
| 9457 | "name": "string"
|
| 9458 | }
|
| 9459 | },
|
| 9460 | {
|
| 9461 | "id": 460,
|
| 9462 | "name": "mode",
|
| 9463 | "kind": 1024,
|
| 9464 | "kindString": "Property",
|
| 9465 | "flags": {},
|
| 9466 | "sources": [
|
| 9467 | {
|
| 9468 | "fileName": "types.ts",
|
| 9469 | "line": 1123,
|
| 9470 | "character": 2
|
| 9471 | }
|
| 9472 | ],
|
| 9473 | "type": {
|
| 9474 | "type": "literal",
|
| 9475 | "value": "renderModal"
|
| 9476 | }
|
| 9477 | },
|
| 9478 | {
|
| 9479 | "id": 462,
|
| 9480 | "name": "parameters",
|
| 9481 | "kind": 1024,
|
| 9482 | "kindString": "Property",
|
| 9483 | "flags": {},
|
| 9484 | "comment": {
|
| 9485 | "shortText": "The arbitrary `parameters` of the modal declared in the `openModal` function"
|
| 9486 | },
|
| 9487 | "sources": [
|
| 9488 | {
|
| 9489 | "fileName": "types.ts",
|
| 9490 | "line": 1127,
|
| 9491 | "character": 2
|
| 9492 | }
|
| 9493 | ],
|
| 9494 | "type": {
|
| 9495 | "type": "reference",
|
| 9496 | "typeArguments": [
|
| 9497 | {
|
| 9498 | "type": "intrinsic",
|
| 9499 | "name": "string"
|
| 9500 | },
|
| 9501 | {
|
| 9502 | "type": "intrinsic",
|
| 9503 | "name": "unknown"
|
| 9504 | }
|
| 9505 | ],
|
| 9506 | "name": "Record"
|
| 9507 | }
|
| 9508 | }
|
| 9509 | ],
|
| 9510 | "groups": [
|
| 9511 | {
|
| 9512 | "title": "Properties",
|
| 9513 | "kind": 1024,
|
| 9514 | "children": [
|
| 9515 | 461,
|
| 9516 | 460,
|
| 9517 | 462
|
| 9518 | ]
|
| 9519 | }
|
| 9520 | ],
|
| 9521 | "sources": [
|
| 9522 | {
|
| 9523 | "fileName": "types.ts",
|
| 9524 | "line": 1122,
|
| 9525 | "character": 46
|
| 9526 | }
|
| 9527 | ]
|
| 9528 | }
|
| 9529 | }
|
| 9530 | },
|
| 9531 | {
|
| 9532 | "id": 72,
|
| 9533 | "name": "RenderModalCtx",
|
| 9534 | "kind": 4194304,
|
| 9535 | "kindString": "Type alias",
|
| 9536 | "flags": {},
|
| 9537 | "sources": [
|
| 9538 | {
|
| 9539 | "fileName": "connect.ts",
|
| 9540 | "line": 62,
|
| 9541 | "character": 12
|
| 9542 | }
|
| 9543 | ],
|
| 9544 | "type": {
|
| 9545 | "type": "intersection",
|
| 9546 | "types": [
|
| 9547 | {
|
| 9548 | "type": "reference",
|
| 9549 | "id": 472,
|
| 9550 | "name": "RenderModalPropertiesAndMethods"
|
| 9551 | },
|
| 9552 | {
|
| 9553 | "type": "reference",
|
| 9554 | "id": 57,
|
| 9555 | "name": "SizingUtilities"
|
| 9556 | }
|
| 9557 | ]
|
| 9558 | }
|
| 9559 | },
|
| 9560 | {
|
| 9561 | "id": 471,
|
| 9562 | "name": "RenderModalMethods",
|
| 9563 | "kind": 4194304,
|
| 9564 | "kindString": "Type alias",
|
| 9565 | "flags": {},
|
| 9566 | "sources": [
|
| 9567 | {
|
| 9568 | "fileName": "types.ts",
|
| 9569 | "line": 1154,
|
| 9570 | "character": 12
|
| 9571 | }
|
| 9572 | ],
|
| 9573 | "type": {
|
| 9574 | "type": "intersection",
|
| 9575 | "types": [
|
| 9576 | {
|
| 9577 | "type": "reference",
|
| 9578 | "id": 397,
|
| 9579 | "name": "RenderMethods"
|
| 9580 | },
|
| 9581 | {
|
| 9582 | "type": "reference",
|
| 9583 | "id": 392,
|
| 9584 | "name": "IframeMethods"
|
| 9585 | },
|
| 9586 | {
|
| 9587 | "type": "reference",
|
| 9588 | "id": 464,
|
| 9589 | "name": "RenderModalAdditionalMethods"
|
| 9590 | }
|
| 9591 | ]
|
| 9592 | }
|
| 9593 | },
|
| 9594 | {
|
| 9595 | "id": 463,
|
| 9596 | "name": "RenderModalProperties",
|
| 9597 | "kind": 4194304,
|
| 9598 | "kindString": "Type alias",
|
| 9599 | "flags": {},
|
| 9600 | "sources": [
|
| 9601 | {
|
| 9602 | "fileName": "types.ts",
|
| 9603 | "line": 1130,
|
| 9604 | "character": 12
|
| 9605 | }
|
| 9606 | ],
|
| 9607 | "type": {
|
| 9608 | "type": "intersection",
|
| 9609 | "types": [
|
| 9610 | {
|
| 9611 | "type": "reference",
|
| 9612 | "id": 281,
|
| 9613 | "name": "RenderProperties"
|
| 9614 | },
|
| 9615 | {
|
| 9616 | "type": "reference",
|
| 9617 | "id": 458,
|
| 9618 | "name": "RenderModalAdditionalProperties"
|
| 9619 | }
|
| 9620 | ]
|
| 9621 | }
|
| 9622 | },
|
| 9623 | {
|
| 9624 | "id": 472,
|
| 9625 | "name": "RenderModalPropertiesAndMethods",
|
| 9626 | "kind": 4194304,
|
| 9627 | "kindString": "Type alias",
|
| 9628 | "flags": {},
|
| 9629 | "sources": [
|
| 9630 | {
|
| 9631 | "fileName": "types.ts",
|
| 9632 | "line": 1158,
|
| 9633 | "character": 12
|
| 9634 | }
|
| 9635 | ],
|
| 9636 | "type": {
|
| 9637 | "type": "intersection",
|
| 9638 | "types": [
|
| 9639 | {
|
| 9640 | "type": "reference",
|
| 9641 | "id": 471,
|
| 9642 | "name": "RenderModalMethods"
|
| 9643 | },
|
| 9644 | {
|
| 9645 | "type": "reference",
|
| 9646 | "id": 463,
|
| 9647 | "name": "RenderModalProperties"
|
| 9648 | }
|
| 9649 | ]
|
| 9650 | }
|
| 9651 | },
|
| 9652 | {
|
| 9653 | "id": 478,
|
| 9654 | "name": "RenderPageAdditionalMethods",
|
| 9655 | "kind": 4194304,
|
| 9656 | "kindString": "Type alias",
|
| 9657 | "flags": {},
|
| 9658 | "sources": [
|
| 9659 | {
|
| 9660 | "fileName": "types.ts",
|
| 9661 | "line": 1171,
|
| 9662 | "character": 12
|
| 9663 | }
|
| 9664 | ],
|
| 9665 | "type": {
|
| 9666 | "type": "reflection",
|
| 9667 | "declaration": {
|
| 9668 | "id": 479,
|
| 9669 | "name": "__type",
|
| 9670 | "kind": 65536,
|
| 9671 | "kindString": "Type literal",
|
| 9672 | "flags": {},
|
| 9673 | "children": [
|
| 9674 | {
|
| 9675 | "id": 480,
|
| 9676 | "name": "getSettings",
|
| 9677 | "kind": 2048,
|
| 9678 | "kindString": "Method",
|
| 9679 | "flags": {},
|
| 9680 | "sources": [
|
| 9681 | {
|
| 9682 | "fileName": "types.ts",
|
| 9683 | "line": 1172,
|
| 9684 | "character": 2
|
| 9685 | }
|
| 9686 | ],
|
| 9687 | "signatures": [
|
| 9688 | {
|
| 9689 | "id": 481,
|
| 9690 | "name": "getSettings",
|
| 9691 | "kind": 4096,
|
| 9692 | "kindString": "Call signature",
|
| 9693 | "flags": {},
|
| 9694 | "type": {
|
| 9695 | "type": "reference",
|
| 9696 | "typeArguments": [
|
| 9697 | {
|
| 9698 | "type": "reference",
|
| 9699 | "id": 477,
|
| 9700 | "name": "RenderPageProperties"
|
| 9701 | }
|
| 9702 | ],
|
| 9703 | "name": "Promise"
|
| 9704 | }
|
| 9705 | }
|
| 9706 | ]
|
| 9707 | }
|
| 9708 | ],
|
| 9709 | "groups": [
|
| 9710 | {
|
| 9711 | "title": "Methods",
|
| 9712 | "kind": 2048,
|
| 9713 | "children": [
|
| 9714 | 480
|
| 9715 | ]
|
| 9716 | }
|
| 9717 | ],
|
| 9718 | "sources": [
|
| 9719 | {
|
| 9720 | "fileName": "types.ts",
|
| 9721 | "line": 1171,
|
| 9722 | "character": 42
|
| 9723 | }
|
| 9724 | ]
|
| 9725 | }
|
| 9726 | }
|
| 9727 | },
|
| 9728 | {
|
| 9729 | "id": 473,
|
| 9730 | "name": "RenderPageAdditionalProperties",
|
| 9731 | "kind": 4194304,
|
| 9732 | "kindString": "Type alias",
|
| 9733 | "flags": {},
|
| 9734 | "comment": {
|
| 9735 | "shortText": "Information regarding the specific page that you need to render"
|
| 9736 | },
|
| 9737 | "sources": [
|
| 9738 | {
|
| 9739 | "fileName": "types.ts",
|
| 9740 | "line": 1162,
|
| 9741 | "character": 12
|
| 9742 | }
|
| 9743 | ],
|
| 9744 | "type": {
|
| 9745 | "type": "reflection",
|
| 9746 | "declaration": {
|
| 9747 | "id": 474,
|
| 9748 | "name": "__type",
|
| 9749 | "kind": 65536,
|
| 9750 | "kindString": "Type literal",
|
| 9751 | "flags": {},
|
| 9752 | "children": [
|
| 9753 | {
|
| 9754 | "id": 475,
|
| 9755 | "name": "mode",
|
| 9756 | "kind": 1024,
|
| 9757 | "kindString": "Property",
|
| 9758 | "flags": {},
|
| 9759 | "sources": [
|
| 9760 | {
|
| 9761 | "fileName": "types.ts",
|
| 9762 | "line": 1163,
|
| 9763 | "character": 2
|
| 9764 | }
|
| 9765 | ],
|
| 9766 | "type": {
|
| 9767 | "type": "literal",
|
| 9768 | "value": "renderPage"
|
| 9769 | }
|
| 9770 | },
|
| 9771 | {
|
| 9772 | "id": 476,
|
| 9773 | "name": "pageId",
|
| 9774 | "kind": 1024,
|
| 9775 | "kindString": "Property",
|
| 9776 | "flags": {},
|
| 9777 | "comment": {
|
| 9778 | "shortText": "The ID of the page that needs to be rendered"
|
| 9779 | },
|
| 9780 | "sources": [
|
| 9781 | {
|
| 9782 | "fileName": "types.ts",
|
| 9783 | "line": 1165,
|
| 9784 | "character": 2
|
| 9785 | }
|
| 9786 | ],
|
| 9787 | "type": {
|
| 9788 | "type": "intrinsic",
|
| 9789 | "name": "string"
|
| 9790 | }
|
| 9791 | }
|
| 9792 | ],
|
| 9793 | "groups": [
|
| 9794 | {
|
| 9795 | "title": "Properties",
|
| 9796 | "kind": 1024,
|
| 9797 | "children": [
|
| 9798 | 475,
|
| 9799 | 476
|
| 9800 | ]
|
| 9801 | }
|
| 9802 | ],
|
| 9803 | "sources": [
|
| 9804 | {
|
| 9805 | "fileName": "types.ts",
|
| 9806 | "line": 1162,
|
| 9807 | "character": 45
|
| 9808 | }
|
| 9809 | ]
|
| 9810 | }
|
| 9811 | }
|
| 9812 | },
|
| 9813 | {
|
| 9814 | "id": 71,
|
| 9815 | "name": "RenderPageCtx",
|
| 9816 | "kind": 4194304,
|
| 9817 | "kindString": "Type alias",
|
| 9818 | "flags": {},
|
| 9819 | "sources": [
|
| 9820 | {
|
| 9821 | "fileName": "connect.ts",
|
| 9822 | "line": 61,
|
| 9823 | "character": 12
|
| 9824 | }
|
| 9825 | ],
|
| 9826 | "type": {
|
| 9827 | "type": "reference",
|
| 9828 | "id": 483,
|
| 9829 | "name": "RenderPagePropertiesAndMethods"
|
| 9830 | }
|
| 9831 | },
|
| 9832 | {
|
| 9833 | "id": 482,
|
| 9834 | "name": "RenderPageMethods",
|
| 9835 | "kind": 4194304,
|
| 9836 | "kindString": "Type alias",
|
| 9837 | "flags": {},
|
| 9838 | "sources": [
|
| 9839 | {
|
| 9840 | "fileName": "types.ts",
|
| 9841 | "line": 1175,
|
| 9842 | "character": 12
|
| 9843 | }
|
| 9844 | ],
|
| 9845 | "type": {
|
| 9846 | "type": "intersection",
|
| 9847 | "types": [
|
| 9848 | {
|
| 9849 | "type": "reference",
|
| 9850 | "id": 397,
|
| 9851 | "name": "RenderMethods"
|
| 9852 | },
|
| 9853 | {
|
| 9854 | "type": "reference",
|
| 9855 | "id": 478,
|
| 9856 | "name": "RenderPageAdditionalMethods"
|
| 9857 | }
|
| 9858 | ]
|
| 9859 | }
|
| 9860 | },
|
| 9861 | {
|
| 9862 | "id": 477,
|
| 9863 | "name": "RenderPageProperties",
|
| 9864 | "kind": 4194304,
|
| 9865 | "kindString": "Type alias",
|
| 9866 | "flags": {},
|
| 9867 | "sources": [
|
| 9868 | {
|
| 9869 | "fileName": "types.ts",
|
| 9870 | "line": 1168,
|
| 9871 | "character": 12
|
| 9872 | }
|
| 9873 | ],
|
| 9874 | "type": {
|
| 9875 | "type": "intersection",
|
| 9876 | "types": [
|
| 9877 | {
|
| 9878 | "type": "reference",
|
| 9879 | "id": 281,
|
| 9880 | "name": "RenderProperties"
|
| 9881 | },
|
| 9882 | {
|
| 9883 | "type": "reference",
|
| 9884 | "id": 473,
|
| 9885 | "name": "RenderPageAdditionalProperties"
|
| 9886 | }
|
| 9887 | ]
|
| 9888 | }
|
| 9889 | },
|
| 9890 | {
|
| 9891 | "id": 483,
|
| 9892 | "name": "RenderPagePropertiesAndMethods",
|
| 9893 | "kind": 4194304,
|
| 9894 | "kindString": "Type alias",
|
| 9895 | "flags": {},
|
| 9896 | "sources": [
|
| 9897 | {
|
| 9898 | "fileName": "types.ts",
|
| 9899 | "line": 1177,
|
| 9900 | "character": 12
|
| 9901 | }
|
| 9902 | ],
|
| 9903 | "type": {
|
| 9904 | "type": "intersection",
|
| 9905 | "types": [
|
| 9906 | {
|
| 9907 | "type": "reference",
|
| 9908 | "id": 482,
|
| 9909 | "name": "RenderPageMethods"
|
| 9910 | },
|
| 9911 | {
|
| 9912 | "type": "reference",
|
| 9913 | "id": 477,
|
| 9914 | "name": "RenderPageProperties"
|
| 9915 | }
|
| 9916 | ]
|
| 9917 | }
|
| 9918 | },
|
| 9919 | {
|
| 9920 | "id": 281,
|
| 9921 | "name": "RenderProperties",
|
| 9922 | "kind": 4194304,
|
| 9923 | "kindString": "Type alias",
|
| 9924 | "flags": {},
|
| 9925 | "sources": [
|
| 9926 | {
|
| 9927 | "fileName": "types.ts",
|
| 9928 | "line": 473,
|
| 9929 | "character": 12
|
| 9930 | }
|
| 9931 | ],
|
| 9932 | "type": {
|
| 9933 | "type": "intersection",
|
| 9934 | "types": [
|
| 9935 | {
|
| 9936 | "type": "reference",
|
| 9937 | "id": 252,
|
| 9938 | "name": "CommonProperties"
|
| 9939 | },
|
| 9940 | {
|
| 9941 | "type": "reference",
|
| 9942 | "id": 273,
|
| 9943 | "name": "RenderAdditionalProperties"
|
| 9944 | }
|
| 9945 | ]
|
| 9946 | }
|
| 9947 | },
|
| 9948 | {
|
| 9949 | "id": 440,
|
| 9950 | "name": "RenderSidebarPanePropertiesAndMethods",
|
| 9951 | "kind": 4194304,
|
| 9952 | "kindString": "Type alias",
|
| 9953 | "flags": {},
|
| 9954 | "sources": [
|
| 9955 | {
|
| 9956 | "fileName": "types.ts",
|
| 9957 | "line": 1080,
|
| 9958 | "character": 12
|
| 9959 | }
|
| 9960 | ],
|
| 9961 | "type": {
|
| 9962 | "type": "intersection",
|
| 9963 | "types": [
|
| 9964 | {
|
| 9965 | "type": "reference",
|
| 9966 | "id": 439,
|
| 9967 | "name": "RenderSidebarPanelMethods"
|
| 9968 | },
|
| 9969 | {
|
| 9970 | "type": "reference",
|
| 9971 | "id": 434,
|
| 9972 | "name": "RenderSidebarPanelProperties"
|
| 9973 | }
|
| 9974 | ]
|
| 9975 | }
|
| 9976 | },
|
| 9977 | {
|
| 9978 | "id": 435,
|
| 9979 | "name": "RenderSidebarPanelAdditionalMethods",
|
| 9980 | "kind": 4194304,
|
| 9981 | "kindString": "Type alias",
|
| 9982 | "flags": {},
|
| 9983 | "sources": [
|
| 9984 | {
|
| 9985 | "fileName": "types.ts",
|
| 9986 | "line": 1073,
|
| 9987 | "character": 12
|
| 9988 | }
|
| 9989 | ],
|
| 9990 | "type": {
|
| 9991 | "type": "reflection",
|
| 9992 | "declaration": {
|
| 9993 | "id": 436,
|
| 9994 | "name": "__type",
|
| 9995 | "kind": 65536,
|
| 9996 | "kindString": "Type literal",
|
| 9997 | "flags": {},
|
| 9998 | "children": [
|
| 9999 | {
|
| 10000 | "id": 437,
|
| 10001 | "name": "getSettings",
|
| 10002 | "kind": 2048,
|
| 10003 | "kindString": "Method",
|
| 10004 | "flags": {},
|
| 10005 | "sources": [
|
| 10006 | {
|
| 10007 | "fileName": "types.ts",
|
| 10008 | "line": 1074,
|
| 10009 | "character": 2
|
| 10010 | }
|
| 10011 | ],
|
| 10012 | "signatures": [
|
| 10013 | {
|
| 10014 | "id": 438,
|
| 10015 | "name": "getSettings",
|
| 10016 | "kind": 4096,
|
| 10017 | "kindString": "Call signature",
|
| 10018 | "flags": {},
|
| 10019 | "type": {
|
| 10020 | "type": "reference",
|
| 10021 | "typeArguments": [
|
| 10022 | {
|
| 10023 | "type": "reference",
|
| 10024 | "id": 434,
|
| 10025 | "name": "RenderSidebarPanelProperties"
|
| 10026 | }
|
| 10027 | ],
|
| 10028 | "name": "Promise"
|
| 10029 | }
|
| 10030 | }
|
| 10031 | ]
|
| 10032 | }
|
| 10033 | ],
|
| 10034 | "groups": [
|
| 10035 | {
|
| 10036 | "title": "Methods",
|
| 10037 | "kind": 2048,
|
| 10038 | "children": [
|
| 10039 | 437
|
| 10040 | ]
|
| 10041 | }
|
| 10042 | ],
|
| 10043 | "sources": [
|
| 10044 | {
|
| 10045 | "fileName": "types.ts",
|
| 10046 | "line": 1073,
|
| 10047 | "character": 50
|
| 10048 | }
|
| 10049 | ]
|
| 10050 | }
|
| 10051 | }
|
| 10052 | },
|
| 10053 | {
|
| 10054 | "id": 429,
|
| 10055 | "name": "RenderSidebarPanelAdditionalProperties",
|
| 10056 | "kind": 4194304,
|
| 10057 | "kindString": "Type alias",
|
| 10058 | "flags": {},
|
| 10059 | "comment": {
|
| 10060 | "shortText": "Information regarding the specific sidebar panel that you need to render"
|
| 10061 | },
|
| 10062 | "sources": [
|
| 10063 | {
|
| 10064 | "fileName": "types.ts",
|
| 10065 | "line": 1059,
|
| 10066 | "character": 12
|
| 10067 | }
|
| 10068 | ],
|
| 10069 | "type": {
|
| 10070 | "type": "reflection",
|
| 10071 | "declaration": {
|
| 10072 | "id": 430,
|
| 10073 | "name": "__type",
|
| 10074 | "kind": 65536,
|
| 10075 | "kindString": "Type literal",
|
| 10076 | "flags": {},
|
| 10077 | "children": [
|
| 10078 | {
|
| 10079 | "id": 431,
|
| 10080 | "name": "mode",
|
| 10081 | "kind": 1024,
|
| 10082 | "kindString": "Property",
|
| 10083 | "flags": {},
|
| 10084 | "sources": [
|
| 10085 | {
|
| 10086 | "fileName": "types.ts",
|
| 10087 | "line": 1060,
|
| 10088 | "character": 2
|
| 10089 | }
|
| 10090 | ],
|
| 10091 | "type": {
|
| 10092 | "type": "literal",
|
| 10093 | "value": "renderItemFormSidebarPanel"
|
| 10094 | }
|
| 10095 | },
|
| 10096 | {
|
| 10097 | "id": 433,
|
| 10098 | "name": "parameters",
|
| 10099 | "kind": 1024,
|
| 10100 | "kindString": "Property",
|
| 10101 | "flags": {},
|
| 10102 | "comment": {
|
| 10103 | "shortText": "The arbitrary `parameters` of the panel declared in the\n`itemFormSidebarPanels` function"
|
| 10104 | },
|
| 10105 | "sources": [
|
| 10106 | {
|
| 10107 | "fileName": "types.ts",
|
| 10108 | "line": 1067,
|
| 10109 | "character": 2
|
| 10110 | }
|
| 10111 | ],
|
| 10112 | "type": {
|
| 10113 | "type": "reference",
|
| 10114 | "typeArguments": [
|
| 10115 | {
|
| 10116 | "type": "intrinsic",
|
| 10117 | "name": "string"
|
| 10118 | },
|
| 10119 | {
|
| 10120 | "type": "intrinsic",
|
| 10121 | "name": "unknown"
|
| 10122 | }
|
| 10123 | ],
|
| 10124 | "name": "Record"
|
| 10125 | }
|
| 10126 | },
|
| 10127 | {
|
| 10128 | "id": 432,
|
| 10129 | "name": "sidebarPaneId",
|
| 10130 | "kind": 1024,
|
| 10131 | "kindString": "Property",
|
| 10132 | "flags": {},
|
| 10133 | "comment": {
|
| 10134 | "shortText": "The ID of the sidebar panel that needs to be rendered"
|
| 10135 | },
|
| 10136 | "sources": [
|
| 10137 | {
|
| 10138 | "fileName": "types.ts",
|
| 10139 | "line": 1062,
|
| 10140 | "character": 2
|
| 10141 | }
|
| 10142 | ],
|
| 10143 | "type": {
|
| 10144 | "type": "intrinsic",
|
| 10145 | "name": "string"
|
| 10146 | }
|
| 10147 | }
|
| 10148 | ],
|
| 10149 | "groups": [
|
| 10150 | {
|
| 10151 | "title": "Properties",
|
| 10152 | "kind": 1024,
|
| 10153 | "children": [
|
| 10154 | 431,
|
| 10155 | 433,
|
| 10156 | 432
|
| 10157 | ]
|
| 10158 | }
|
| 10159 | ],
|
| 10160 | "sources": [
|
| 10161 | {
|
| 10162 | "fileName": "types.ts",
|
| 10163 | "line": 1059,
|
| 10164 | "character": 53
|
| 10165 | }
|
| 10166 | ]
|
| 10167 | }
|
| 10168 | }
|
| 10169 | },
|
| 10170 | {
|
| 10171 | "id": 439,
|
| 10172 | "name": "RenderSidebarPanelMethods",
|
| 10173 | "kind": 4194304,
|
| 10174 | "kindString": "Type alias",
|
| 10175 | "flags": {},
|
| 10176 | "sources": [
|
| 10177 | {
|
| 10178 | "fileName": "types.ts",
|
| 10179 | "line": 1077,
|
| 10180 | "character": 12
|
| 10181 | }
|
| 10182 | ],
|
| 10183 | "type": {
|
| 10184 | "type": "intersection",
|
| 10185 | "types": [
|
| 10186 | {
|
| 10187 | "type": "reference",
|
| 10188 | "id": 428,
|
| 10189 | "name": "ItemFormMethods"
|
| 10190 | },
|
| 10191 | {
|
| 10192 | "type": "reference",
|
| 10193 | "id": 435,
|
| 10194 | "name": "RenderSidebarPanelAdditionalMethods"
|
| 10195 | }
|
| 10196 | ]
|
| 10197 | }
|
| 10198 | },
|
| 10199 | {
|
| 10200 | "id": 434,
|
| 10201 | "name": "RenderSidebarPanelProperties",
|
| 10202 | "kind": 4194304,
|
| 10203 | "kindString": "Type alias",
|
| 10204 | "flags": {},
|
| 10205 | "sources": [
|
| 10206 | {
|
| 10207 | "fileName": "types.ts",
|
| 10208 | "line": 1070,
|
| 10209 | "character": 12
|
| 10210 | }
|
| 10211 | ],
|
| 10212 | "type": {
|
| 10213 | "type": "intersection",
|
| 10214 | "types": [
|
| 10215 | {
|
| 10216 | "type": "reference",
|
| 10217 | "id": 407,
|
| 10218 | "name": "ItemFormProperties"
|
| 10219 | },
|
| 10220 | {
|
| 10221 | "type": "reference",
|
| 10222 | "id": 429,
|
| 10223 | "name": "RenderSidebarPanelAdditionalProperties"
|
| 10224 | }
|
| 10225 | ]
|
| 10226 | }
|
| 10227 | },
|
| 10228 | {
|
| 10229 | "id": 138,
|
| 10230 | "name": "SettingsAreaSidebarItem",
|
| 10231 | "kind": 4194304,
|
| 10232 | "kindString": "Type alias",
|
| 10233 | "flags": {},
|
| 10234 | "comment": {
|
| 10235 | "shortText": "An item contained in a Settings Area group"
|
| 10236 | },
|
| 10237 | "sources": [
|
| 10238 | {
|
| 10239 | "fileName": "types.ts",
|
| 10240 | "line": 61,
|
| 10241 | "character": 12
|
| 10242 | }
|
| 10243 | ],
|
| 10244 | "type": {
|
| 10245 | "type": "reflection",
|
| 10246 | "declaration": {
|
| 10247 | "id": 139,
|
| 10248 | "name": "__type",
|
| 10249 | "kind": 65536,
|
| 10250 | "kindString": "Type literal",
|
| 10251 | "flags": {},
|
| 10252 | "children": [
|
| 10253 | {
|
| 10254 | "id": 141,
|
| 10255 | "name": "icon",
|
| 10256 | "kind": 1024,
|
| 10257 | "kindString": "Property",
|
| 10258 | "flags": {},
|
| 10259 | "comment": {
|
| 10260 | "shortText": "FontAwesome icon name to be shown alongside the label"
|
| 10261 | },
|
| 10262 | "sources": [
|
| 10263 | {
|
| 10264 | "fileName": "types.ts",
|
| 10265 | "line": 65,
|
| 10266 | "character": 2
|
| 10267 | }
|
| 10268 | ],
|
| 10269 | "type": {
|
| 10270 | "type": "intrinsic",
|
| 10271 | "name": "string"
|
| 10272 | }
|
| 10273 | },
|
| 10274 | {
|
| 10275 | "id": 140,
|
| 10276 | "name": "label",
|
| 10277 | "kind": 1024,
|
| 10278 | "kindString": "Property",
|
| 10279 | "flags": {},
|
| 10280 | "comment": {
|
| 10281 | "shortText": "Label to be shown. Must be unique."
|
| 10282 | },
|
| 10283 | "sources": [
|
| 10284 | {
|
| 10285 | "fileName": "types.ts",
|
| 10286 | "line": 63,
|
| 10287 | "character": 2
|
| 10288 | }
|
| 10289 | ],
|
| 10290 | "type": {
|
| 10291 | "type": "intrinsic",
|
| 10292 | "name": "string"
|
| 10293 | }
|
| 10294 | },
|
| 10295 | {
|
| 10296 | "id": 142,
|
| 10297 | "name": "pointsTo",
|
| 10298 | "kind": 1024,
|
| 10299 | "kindString": "Property",
|
| 10300 | "flags": {},
|
| 10301 | "comment": {
|
| 10302 | "shortText": "ID of the page linked to the item"
|
| 10303 | },
|
| 10304 | "sources": [
|
| 10305 | {
|
| 10306 | "fileName": "types.ts",
|
| 10307 | "line": 67,
|
| 10308 | "character": 2
|
| 10309 | }
|
| 10310 | ],
|
| 10311 | "type": {
|
| 10312 | "type": "reflection",
|
| 10313 | "declaration": {
|
| 10314 | "id": 143,
|
| 10315 | "name": "__type",
|
| 10316 | "kind": 65536,
|
| 10317 | "kindString": "Type literal",
|
| 10318 | "flags": {},
|
| 10319 | "children": [
|
| 10320 | {
|
| 10321 | "id": 144,
|
| 10322 | "name": "pageId",
|
| 10323 | "kind": 1024,
|
| 10324 | "kindString": "Property",
|
| 10325 | "flags": {},
|
| 10326 | "sources": [
|
| 10327 | {
|
| 10328 | "fileName": "types.ts",
|
| 10329 | "line": 68,
|
| 10330 | "character": 4
|
| 10331 | }
|
| 10332 | ],
|
| 10333 | "type": {
|
| 10334 | "type": "intrinsic",
|
| 10335 | "name": "string"
|
| 10336 | }
|
| 10337 | }
|
| 10338 | ],
|
| 10339 | "groups": [
|
| 10340 | {
|
| 10341 | "title": "Properties",
|
| 10342 | "kind": 1024,
|
| 10343 | "children": [
|
| 10344 | 144
|
| 10345 | ]
|
| 10346 | }
|
| 10347 | ],
|
| 10348 | "sources": [
|
| 10349 | {
|
| 10350 | "fileName": "types.ts",
|
| 10351 | "line": 67,
|
| 10352 | "character": 12
|
| 10353 | }
|
| 10354 | ]
|
| 10355 | }
|
| 10356 | }
|
| 10357 | }
|
| 10358 | ],
|
| 10359 | "groups": [
|
| 10360 | {
|
| 10361 | "title": "Properties",
|
| 10362 | "kind": 1024,
|
| 10363 | "children": [
|
| 10364 | 141,
|
| 10365 | 140,
|
| 10366 | 142
|
| 10367 | ]
|
| 10368 | }
|
| 10369 | ],
|
| 10370 | "sources": [
|
| 10371 | {
|
| 10372 | "fileName": "types.ts",
|
| 10373 | "line": 61,
|
| 10374 | "character": 38
|
| 10375 | }
|
| 10376 | ]
|
| 10377 | }
|
| 10378 | }
|
| 10379 | },
|
| 10380 | {
|
| 10381 | "id": 145,
|
| 10382 | "name": "SettingsAreaSidebarItemGroup",
|
| 10383 | "kind": 4194304,
|
| 10384 | "kindString": "Type alias",
|
| 10385 | "flags": {},
|
| 10386 | "comment": {
|
| 10387 | "shortText": "The sidebar in the Settings Area presents a number of pages grouped by topic.\nThis object represents a new group to be added in the sideebar to the\nstandard ones DatoCMS provides."
|
| 10388 | },
|
| 10389 | "sources": [
|
| 10390 | {
|
| 10391 | "fileName": "types.ts",
|
| 10392 | "line": 77,
|
| 10393 | "character": 12
|
| 10394 | }
|
| 10395 | ],
|
| 10396 | "type": {
|
| 10397 | "type": "reflection",
|
| 10398 | "declaration": {
|
| 10399 | "id": 146,
|
| 10400 | "name": "__type",
|
| 10401 | "kind": 65536,
|
| 10402 | "kindString": "Type literal",
|
| 10403 | "flags": {},
|
| 10404 | "children": [
|
| 10405 | {
|
| 10406 | "id": 148,
|
| 10407 | "name": "items",
|
| 10408 | "kind": 1024,
|
| 10409 | "kindString": "Property",
|
| 10410 | "flags": {},
|
| 10411 | "comment": {
|
| 10412 | "shortText": "The list of items it contains *"
|
| 10413 | },
|
| 10414 | "sources": [
|
| 10415 | {
|
| 10416 | "fileName": "types.ts",
|
| 10417 | "line": 81,
|
| 10418 | "character": 2
|
| 10419 | }
|
| 10420 | ],
|
| 10421 | "type": {
|
| 10422 | "type": "array",
|
| 10423 | "elementType": {
|
| 10424 | "type": "reference",
|
| 10425 | "id": 138,
|
| 10426 | "name": "SettingsAreaSidebarItem"
|
| 10427 | }
|
| 10428 | }
|
| 10429 | },
|
| 10430 | {
|
| 10431 | "id": 147,
|
| 10432 | "name": "label",
|
| 10433 | "kind": 1024,
|
| 10434 | "kindString": "Property",
|
| 10435 | "flags": {},
|
| 10436 | "comment": {
|
| 10437 | "shortText": "Label to be shown. Must be unique."
|
| 10438 | },
|
| 10439 | "sources": [
|
| 10440 | {
|
| 10441 | "fileName": "types.ts",
|
| 10442 | "line": 79,
|
| 10443 | "character": 2
|
| 10444 | }
|
| 10445 | ],
|
| 10446 | "type": {
|
| 10447 | "type": "intrinsic",
|
| 10448 | "name": "string"
|
| 10449 | }
|
| 10450 | },
|
| 10451 | {
|
| 10452 | "id": 149,
|
| 10453 | "name": "placement",
|
| 10454 | "kind": 1024,
|
| 10455 | "kindString": "Property",
|
| 10456 | "flags": {
|
| 10457 | "isOptional": true
|
| 10458 | },
|
| 10459 | "comment": {
|
| 10460 | "shortText": "Expresses where you want the group to be placed inside the sidebar. If not\nspecified, the item will be placed after the standard items provided by\nDatoCMS itself."
|
| 10461 | },
|
| 10462 | "sources": [
|
| 10463 | {
|
| 10464 | "fileName": "types.ts",
|
| 10465 | "line": 87,
|
| 10466 | "character": 2
|
| 10467 | }
|
| 10468 | ],
|
| 10469 | "type": {
|
| 10470 | "type": "tuple",
|
| 10471 | "elements": [
|
| 10472 | {
|
| 10473 | "type": "union",
|
| 10474 | "types": [
|
| 10475 | {
|
| 10476 | "type": "literal",
|
| 10477 | "value": "before"
|
| 10478 | },
|
| 10479 | {
|
| 10480 | "type": "literal",
|
| 10481 | "value": "after"
|
| 10482 | }
|
| 10483 | ]
|
| 10484 | },
|
| 10485 | {
|
| 10486 | "type": "union",
|
| 10487 | "types": [
|
| 10488 | {
|
| 10489 | "type": "literal",
|
| 10490 | "value": "environment"
|
| 10491 | },
|
| 10492 | {
|
| 10493 | "type": "literal",
|
| 10494 | "value": "project"
|
| 10495 | },
|
| 10496 | {
|
| 10497 | "type": "literal",
|
| 10498 | "value": "permissions"
|
| 10499 | },
|
| 10500 | {
|
| 10501 | "type": "literal",
|
| 10502 | "value": "webhooks"
|
| 10503 | },
|
| 10504 | {
|
| 10505 | "type": "literal",
|
| 10506 | "value": "deployment"
|
| 10507 | },
|
| 10508 | {
|
| 10509 | "type": "literal",
|
| 10510 | "value": "sso"
|
| 10511 | },
|
| 10512 | {
|
| 10513 | "type": "literal",
|
| 10514 | "value": "auditLog"
|
| 10515 | },
|
| 10516 | {
|
| 10517 | "type": "literal",
|
| 10518 | "value": "usage"
|
| 10519 | }
|
| 10520 | ]
|
| 10521 | }
|
| 10522 | ]
|
| 10523 | }
|
| 10524 | },
|
| 10525 | {
|
| 10526 | "id": 150,
|
| 10527 | "name": "rank",
|
| 10528 | "kind": 1024,
|
| 10529 | "kindString": "Property",
|
| 10530 | "flags": {
|
| 10531 | "isOptional": true
|
| 10532 | },
|
| 10533 | "comment": {
|
| 10534 | "shortText": "If different plugins specify the same `placement` for their sections, they\nwill be displayed by ascending `rank`. If you want to specify an explicit\nvalue for `rank`, make sure to offer a way for final users to customize it\ninside the plugin's settings form, otherwise the hardcoded value you choose\nmight clash with the one of another plugin! *"
|
| 10535 | },
|
| 10536 | "sources": [
|
| 10537 | {
|
| 10538 | "fileName": "types.ts",
|
| 10539 | "line": 107,
|
| 10540 | "character": 2
|
| 10541 | }
|
| 10542 | ],
|
| 10543 | "type": {
|
| 10544 | "type": "intrinsic",
|
| 10545 | "name": "number"
|
| 10546 | }
|
| 10547 | }
|
| 10548 | ],
|
| 10549 | "groups": [
|
| 10550 | {
|
| 10551 | "title": "Properties",
|
| 10552 | "kind": 1024,
|
| 10553 | "children": [
|
| 10554 | 148,
|
| 10555 | 147,
|
| 10556 | 149,
|
| 10557 | 150
|
| 10558 | ]
|
| 10559 | }
|
| 10560 | ],
|
| 10561 | "sources": [
|
| 10562 | {
|
| 10563 | "fileName": "types.ts",
|
| 10564 | "line": 77,
|
| 10565 | "character": 43
|
| 10566 | }
|
| 10567 | ]
|
| 10568 | }
|
| 10569 | }
|
| 10570 | },
|
| 10571 | {
|
| 10572 | "id": 57,
|
| 10573 | "name": "SizingUtilities",
|
| 10574 | "kind": 4194304,
|
| 10575 | "kindString": "Type alias",
|
| 10576 | "flags": {},
|
| 10577 | "sources": [
|
| 10578 | {
|
| 10579 | "fileName": "connect.ts",
|
| 10580 | "line": 38,
|
| 10581 | "character": 12
|
| 10582 | }
|
| 10583 | ],
|
| 10584 | "type": {
|
| 10585 | "type": "reflection",
|
| 10586 | "declaration": {
|
| 10587 | "id": 58,
|
| 10588 | "name": "__type",
|
| 10589 | "kind": 65536,
|
| 10590 | "kindString": "Type literal",
|
| 10591 | "flags": {},
|
| 10592 | "children": [
|
| 10593 | {
|
| 10594 | "id": 59,
|
| 10595 | "name": "startAutoResizer",
|
| 10596 | "kind": 2048,
|
| 10597 | "kindString": "Method",
|
| 10598 | "flags": {},
|
| 10599 | "sources": [
|
| 10600 | {
|
| 10601 | "fileName": "connect.ts",
|
| 10602 | "line": 44,
|
| 10603 | "character": 2
|
| 10604 | }
|
| 10605 | ],
|
| 10606 | "signatures": [
|
| 10607 | {
|
| 10608 | "id": 60,
|
| 10609 | "name": "startAutoResizer",
|
| 10610 | "kind": 4096,
|
| 10611 | "kindString": "Call signature",
|
| 10612 | "flags": {},
|
| 10613 | "comment": {
|
| 10614 | "shortText": "Listens for DOM changes and automatically calls `setHeight` when it detects a change.\nIf you're using `datocms-react-ui` package, the `<Canvas />` component already takes\ncare of calling this method for you."
|
| 10615 | },
|
| 10616 | "type": {
|
| 10617 | "type": "intrinsic",
|
| 10618 | "name": "void"
|
| 10619 | }
|
| 10620 | }
|
| 10621 | ]
|
| 10622 | },
|
| 10623 | {
|
| 10624 | "id": 61,
|
| 10625 | "name": "stopAutoResizer",
|
| 10626 | "kind": 2048,
|
| 10627 | "kindString": "Method",
|
| 10628 | "flags": {},
|
| 10629 | "sources": [
|
| 10630 | {
|
| 10631 | "fileName": "connect.ts",
|
| 10632 | "line": 46,
|
| 10633 | "character": 2
|
| 10634 | }
|
| 10635 | ],
|
| 10636 | "signatures": [
|
| 10637 | {
|
| 10638 | "id": 62,
|
| 10639 | "name": "stopAutoResizer",
|
| 10640 | "kind": 4096,
|
| 10641 | "kindString": "Call signature",
|
| 10642 | "flags": {},
|
| 10643 | "comment": {
|
| 10644 | "shortText": "Stops resizing the iframe automatically"
|
| 10645 | },
|
| 10646 | "type": {
|
| 10647 | "type": "intrinsic",
|
| 10648 | "name": "void"
|
| 10649 | }
|
| 10650 | }
|
| 10651 | ]
|
| 10652 | },
|
| 10653 | {
|
| 10654 | "id": 63,
|
| 10655 | "name": "updateHeight",
|
| 10656 | "kind": 2048,
|
| 10657 | "kindString": "Method",
|
| 10658 | "flags": {},
|
| 10659 | "sources": [
|
| 10660 | {
|
| 10661 | "fileName": "connect.ts",
|
| 10662 | "line": 51,
|
| 10663 | "character": 2
|
| 10664 | }
|
| 10665 | ],
|
| 10666 | "signatures": [
|
| 10667 | {
|
| 10668 | "id": 64,
|
| 10669 | "name": "updateHeight",
|
| 10670 | "kind": 4096,
|
| 10671 | "kindString": "Call signature",
|
| 10672 | "flags": {},
|
| 10673 | "comment": {
|
| 10674 | "shortText": "Triggers a change in the size of the iframe. If you don't explicitely pass a\n`newHeight` it will be automatically calculated using the iframe content at the moment"
|
| 10675 | },
|
| 10676 | "parameters": [
|
| 10677 | {
|
| 10678 | "id": 65,
|
| 10679 | "name": "newHeight",
|
| 10680 | "kind": 32768,
|
| 10681 | "kindString": "Parameter",
|
| 10682 | "flags": {
|
| 10683 | "isOptional": true
|
| 10684 | },
|
| 10685 | "type": {
|
| 10686 | "type": "intrinsic",
|
| 10687 | "name": "number"
|
| 10688 | }
|
| 10689 | }
|
| 10690 | ],
|
| 10691 | "type": {
|
| 10692 | "type": "intrinsic",
|
| 10693 | "name": "void"
|
| 10694 | }
|
| 10695 | }
|
| 10696 | ]
|
| 10697 | }
|
| 10698 | ],
|
| 10699 | "groups": [
|
| 10700 | {
|
| 10701 | "title": "Methods",
|
| 10702 | "kind": 2048,
|
| 10703 | "children": [
|
| 10704 | 59,
|
| 10705 | 61,
|
| 10706 | 63
|
| 10707 | ]
|
| 10708 | }
|
| 10709 | ],
|
| 10710 | "sources": [
|
| 10711 | {
|
| 10712 | "fileName": "connect.ts",
|
| 10713 | "line": 38,
|
| 10714 | "character": 30
|
| 10715 | }
|
| 10716 | ]
|
| 10717 | }
|
| 10718 | }
|
| 10719 | },
|
| 10720 | {
|
| 10721 | "id": 204,
|
| 10722 | "name": "Theme",
|
| 10723 | "kind": 4194304,
|
| 10724 | "kindString": "Type alias",
|
| 10725 | "flags": {},
|
| 10726 | "comment": {
|
| 10727 | "shortText": "An object containing the theme colors for the current DatoCMS project"
|
| 10728 | },
|
| 10729 | "sources": [
|
| 10730 | {
|
| 10731 | "fileName": "types.ts",
|
| 10732 | "line": 297,
|
| 10733 | "character": 12
|
| 10734 | }
|
| 10735 | ],
|
| 10736 | "type": {
|
| 10737 | "type": "reflection",
|
| 10738 | "declaration": {
|
| 10739 | "id": 205,
|
| 10740 | "name": "__type",
|
| 10741 | "kind": 65536,
|
| 10742 | "kindString": "Type literal",
|
| 10743 | "flags": {},
|
| 10744 | "children": [
|
| 10745 | {
|
| 10746 | "id": 207,
|
| 10747 | "name": "accentColor",
|
| 10748 | "kind": 1024,
|
| 10749 | "kindString": "Property",
|
| 10750 | "flags": {},
|
| 10751 | "sources": [
|
| 10752 | {
|
| 10753 | "fileName": "types.ts",
|
| 10754 | "line": 299,
|
| 10755 | "character": 2
|
| 10756 | }
|
| 10757 | ],
|
| 10758 | "type": {
|
| 10759 | "type": "intrinsic",
|
| 10760 | "name": "string"
|
| 10761 | }
|
| 10762 | },
|
| 10763 | {
|
| 10764 | "id": 210,
|
| 10765 | "name": "darkColor",
|
| 10766 | "kind": 1024,
|
| 10767 | "kindString": "Property",
|
| 10768 | "flags": {},
|
| 10769 | "sources": [
|
| 10770 | {
|
| 10771 | "fileName": "types.ts",
|
| 10772 | "line": 302,
|
| 10773 | "character": 2
|
| 10774 | }
|
| 10775 | ],
|
| 10776 | "type": {
|
| 10777 | "type": "intrinsic",
|
| 10778 | "name": "string"
|
| 10779 | }
|
| 10780 | },
|
| 10781 | {
|
| 10782 | "id": 209,
|
| 10783 | "name": "lightColor",
|
| 10784 | "kind": 1024,
|
| 10785 | "kindString": "Property",
|
| 10786 | "flags": {},
|
| 10787 | "sources": [
|
| 10788 | {
|
| 10789 | "fileName": "types.ts",
|
| 10790 | "line": 301,
|
| 10791 | "character": 2
|
| 10792 | }
|
| 10793 | ],
|
| 10794 | "type": {
|
| 10795 | "type": "intrinsic",
|
| 10796 | "name": "string"
|
| 10797 | }
|
| 10798 | },
|
| 10799 | {
|
| 10800 | "id": 206,
|
| 10801 | "name": "primaryColor",
|
| 10802 | "kind": 1024,
|
| 10803 | "kindString": "Property",
|
| 10804 | "flags": {},
|
| 10805 | "sources": [
|
| 10806 | {
|
| 10807 | "fileName": "types.ts",
|
| 10808 | "line": 298,
|
| 10809 | "character": 2
|
| 10810 | }
|
| 10811 | ],
|
| 10812 | "type": {
|
| 10813 | "type": "intrinsic",
|
| 10814 | "name": "string"
|
| 10815 | }
|
| 10816 | },
|
| 10817 | {
|
| 10818 | "id": 208,
|
| 10819 | "name": "semiTransparentAccentColor",
|
| 10820 | "kind": 1024,
|
| 10821 | "kindString": "Property",
|
| 10822 | "flags": {},
|
| 10823 | "sources": [
|
| 10824 | {
|
| 10825 | "fileName": "types.ts",
|
| 10826 | "line": 300,
|
| 10827 | "character": 2
|
| 10828 | }
|
| 10829 | ],
|
| 10830 | "type": {
|
| 10831 | "type": "intrinsic",
|
| 10832 | "name": "string"
|
| 10833 | }
|
| 10834 | }
|
| 10835 | ],
|
| 10836 | "groups": [
|
| 10837 | {
|
| 10838 | "title": "Properties",
|
| 10839 | "kind": 1024,
|
| 10840 | "children": [
|
| 10841 | 207,
|
| 10842 | 210,
|
| 10843 | 209,
|
| 10844 | 206,
|
| 10845 | 208
|
| 10846 | ]
|
| 10847 | }
|
| 10848 | ],
|
| 10849 | "sources": [
|
| 10850 | {
|
| 10851 | "fileName": "types.ts",
|
| 10852 | "line": 297,
|
| 10853 | "character": 20
|
| 10854 | }
|
| 10855 | ]
|
| 10856 | }
|
| 10857 | }
|
| 10858 | },
|
| 10859 | {
|
| 10860 | "id": 230,
|
| 10861 | "name": "Toast",
|
| 10862 | "kind": 4194304,
|
| 10863 | "kindString": "Type alias",
|
| 10864 | "flags": {},
|
| 10865 | "comment": {
|
| 10866 | "shortText": "A toast notification to present to the user"
|
| 10867 | },
|
| 10868 | "sources": [
|
| 10869 | {
|
| 10870 | "fileName": "types.ts",
|
| 10871 | "line": 350,
|
| 10872 | "character": 12
|
| 10873 | }
|
| 10874 | ],
|
| 10875 | "typeParameter": [
|
| 10876 | {
|
| 10877 | "id": 240,
|
| 10878 | "name": "CtaValue",
|
| 10879 | "kind": 131072,
|
| 10880 | "kindString": "Type parameter",
|
| 10881 | "flags": {},
|
| 10882 | "default": {
|
| 10883 | "type": "intrinsic",
|
| 10884 | "name": "unknown"
|
| 10885 | }
|
| 10886 | }
|
| 10887 | ],
|
| 10888 | "type": {
|
| 10889 | "type": "reflection",
|
| 10890 | "declaration": {
|
| 10891 | "id": 231,
|
| 10892 | "name": "__type",
|
| 10893 | "kind": 65536,
|
| 10894 | "kindString": "Type literal",
|
| 10895 | "flags": {},
|
| 10896 | "children": [
|
| 10897 | {
|
| 10898 | "id": 234,
|
| 10899 | "name": "cta",
|
| 10900 | "kind": 1024,
|
| 10901 | "kindString": "Property",
|
| 10902 | "flags": {
|
| 10903 | "isOptional": true
|
| 10904 | },
|
| 10905 | "comment": {
|
| 10906 | "shortText": "An optional button to show inside the toast"
|
| 10907 | },
|
| 10908 | "sources": [
|
| 10909 | {
|
| 10910 | "fileName": "types.ts",
|
| 10911 | "line": 356,
|
| 10912 | "character": 2
|
| 10913 | }
|
| 10914 | ],
|
| 10915 | "type": {
|
| 10916 | "type": "reflection",
|
| 10917 | "declaration": {
|
| 10918 | "id": 235,
|
| 10919 | "name": "__type",
|
| 10920 | "kind": 65536,
|
| 10921 | "kindString": "Type literal",
|
| 10922 | "flags": {},
|
| 10923 | "children": [
|
| 10924 | {
|
| 10925 | "id": 236,
|
| 10926 | "name": "label",
|
| 10927 | "kind": 1024,
|
| 10928 | "kindString": "Property",
|
| 10929 | "flags": {},
|
| 10930 | "comment": {
|
| 10931 | "shortText": "Label for the button"
|
| 10932 | },
|
| 10933 | "sources": [
|
| 10934 | {
|
| 10935 | "fileName": "types.ts",
|
| 10936 | "line": 358,
|
| 10937 | "character": 4
|
| 10938 | }
|
| 10939 | ],
|
| 10940 | "type": {
|
| 10941 | "type": "intrinsic",
|
| 10942 | "name": "string"
|
| 10943 | }
|
| 10944 | },
|
| 10945 | {
|
| 10946 | "id": 237,
|
| 10947 | "name": "value",
|
| 10948 | "kind": 1024,
|
| 10949 | "kindString": "Property",
|
| 10950 | "flags": {},
|
| 10951 | "comment": {
|
| 10952 | "shortText": "The value to be returned by the `customToast` promise if the button is\nclicked by the user"
|
| 10953 | },
|
| 10954 | "sources": [
|
| 10955 | {
|
| 10956 | "fileName": "types.ts",
|
| 10957 | "line": 363,
|
| 10958 | "character": 4
|
| 10959 | }
|
| 10960 | ],
|
| 10961 | "type": {
|
| 10962 | "type": "reference",
|
| 10963 | "id": 240,
|
| 10964 | "name": "CtaValue"
|
| 10965 | }
|
| 10966 | }
|
| 10967 | ],
|
| 10968 | "groups": [
|
| 10969 | {
|
| 10970 | "title": "Properties",
|
| 10971 | "kind": 1024,
|
| 10972 | "children": [
|
| 10973 | 236,
|
| 10974 | 237
|
| 10975 | ]
|
| 10976 | }
|
| 10977 | ],
|
| 10978 | "sources": [
|
| 10979 | {
|
| 10980 | "fileName": "types.ts",
|
| 10981 | "line": 356,
|
| 10982 | "character": 8
|
| 10983 | }
|
| 10984 | ]
|
| 10985 | }
|
| 10986 | }
|
| 10987 | },
|
| 10988 | {
|
| 10989 | "id": 239,
|
| 10990 | "name": "dismissAfterTimeout",
|
| 10991 | "kind": 1024,
|
| 10992 | "kindString": "Property",
|
| 10993 | "flags": {
|
| 10994 | "isOptional": true
|
| 10995 | },
|
| 10996 | "comment": {
|
| 10997 | "shortText": "Whether the toast is to be automatically closed after some time (`true`\nwill use the default DatoCMS time interval)"
|
| 10998 | },
|
| 10999 | "sources": [
|
| 11000 | {
|
| 11001 | "fileName": "types.ts",
|
| 11002 | "line": 371,
|
| 11003 | "character": 2
|
| 11004 | }
|
| 11005 | ],
|
| 11006 | "type": {
|
| 11007 | "type": "union",
|
| 11008 | "types": [
|
| 11009 | {
|
| 11010 | "type": "intrinsic",
|
| 11011 | "name": "boolean"
|
| 11012 | },
|
| 11013 | {
|
| 11014 | "type": "intrinsic",
|
| 11015 | "name": "number"
|
| 11016 | }
|
| 11017 | ]
|
| 11018 | }
|
| 11019 | },
|
| 11020 | {
|
| 11021 | "id": 238,
|
| 11022 | "name": "dismissOnPageChange",
|
| 11023 | "kind": 1024,
|
| 11024 | "kindString": "Property",
|
| 11025 | "flags": {
|
| 11026 | "isOptional": true
|
| 11027 | },
|
| 11028 | "comment": {
|
| 11029 | "shortText": "Whether the toast is to be automatically closed if the user changes page"
|
| 11030 | },
|
| 11031 | "sources": [
|
| 11032 | {
|
| 11033 | "fileName": "types.ts",
|
| 11034 | "line": 366,
|
| 11035 | "character": 2
|
| 11036 | }
|
| 11037 | ],
|
| 11038 | "type": {
|
| 11039 | "type": "intrinsic",
|
| 11040 | "name": "boolean"
|
| 11041 | }
|
| 11042 | },
|
| 11043 | {
|
| 11044 | "id": 232,
|
| 11045 | "name": "message",
|
| 11046 | "kind": 1024,
|
| 11047 | "kindString": "Property",
|
| 11048 | "flags": {},
|
| 11049 | "comment": {
|
| 11050 | "shortText": "Message of the notification"
|
| 11051 | },
|
| 11052 | "sources": [
|
| 11053 | {
|
| 11054 | "fileName": "types.ts",
|
| 11055 | "line": 352,
|
| 11056 | "character": 2
|
| 11057 | }
|
| 11058 | ],
|
| 11059 | "type": {
|
| 11060 | "type": "intrinsic",
|
| 11061 | "name": "string"
|
| 11062 | }
|
| 11063 | },
|
| 11064 | {
|
| 11065 | "id": 233,
|
| 11066 | "name": "type",
|
| 11067 | "kind": 1024,
|
| 11068 | "kindString": "Property",
|
| 11069 | "flags": {},
|
| 11070 | "comment": {
|
| 11071 | "shortText": "Type of notification. Will present the toast in a different color accent."
|
| 11072 | },
|
| 11073 | "sources": [
|
| 11074 | {
|
| 11075 | "fileName": "types.ts",
|
| 11076 | "line": 354,
|
| 11077 | "character": 2
|
| 11078 | }
|
| 11079 | ],
|
| 11080 | "type": {
|
| 11081 | "type": "union",
|
| 11082 | "types": [
|
| 11083 | {
|
| 11084 | "type": "literal",
|
| 11085 | "value": "notice"
|
| 11086 | },
|
| 11087 | {
|
| 11088 | "type": "literal",
|
| 11089 | "value": "alert"
|
| 11090 | },
|
| 11091 | {
|
| 11092 | "type": "literal",
|
| 11093 | "value": "warning"
|
| 11094 | }
|
| 11095 | ]
|
| 11096 | }
|
| 11097 | }
|
| 11098 | ],
|
| 11099 | "groups": [
|
| 11100 | {
|
| 11101 | "title": "Properties",
|
| 11102 | "kind": 1024,
|
| 11103 | "children": [
|
| 11104 | 234,
|
| 11105 | 239,
|
| 11106 | 238,
|
| 11107 | 232,
|
| 11108 | 233
|
| 11109 | ]
|
| 11110 | }
|
| 11111 | ],
|
| 11112 | "sources": [
|
| 11113 | {
|
| 11114 | "fileName": "types.ts",
|
| 11115 | "line": 350,
|
| 11116 | "character": 40
|
| 11117 | }
|
| 11118 | ]
|
| 11119 | }
|
| 11120 | }
|
| 11121 | },
|
| 11122 | {
|
| 11123 | "id": 346,
|
| 11124 | "name": "ToastMethods",
|
| 11125 | "kind": 4194304,
|
| 11126 | "kindString": "Type alias",
|
| 11127 | "flags": {},
|
| 11128 | "comment": {
|
| 11129 | "shortText": "These methods can be used to show UI-consistent toast notifications to the end-user"
|
| 11130 | },
|
| 11131 | "sources": [
|
| 11132 | {
|
| 11133 | "fileName": "types.ts",
|
| 11134 | "line": 720,
|
| 11135 | "character": 12
|
| 11136 | }
|
| 11137 | ],
|
| 11138 | "type": {
|
| 11139 | "type": "reflection",
|
| 11140 | "declaration": {
|
| 11141 | "id": 347,
|
| 11142 | "name": "__type",
|
| 11143 | "kind": 65536,
|
| 11144 | "kindString": "Type literal",
|
| 11145 | "flags": {},
|
| 11146 | "children": [
|
| 11147 | {
|
| 11148 | "id": 348,
|
| 11149 | "name": "alert",
|
| 11150 | "kind": 2048,
|
| 11151 | "kindString": "Method",
|
| 11152 | "flags": {},
|
| 11153 | "sources": [
|
| 11154 | {
|
| 11155 | "fileName": "types.ts",
|
| 11156 | "line": 735,
|
| 11157 | "character": 2
|
| 11158 | }
|
| 11159 | ],
|
| 11160 | "signatures": [
|
| 11161 | {
|
| 11162 | "id": 349,
|
| 11163 | "name": "alert",
|
| 11164 | "kind": 4096,
|
| 11165 | "kindString": "Call signature",
|
| 11166 | "flags": {},
|
| 11167 | "comment": {
|
| 11168 | "shortText": "Triggers an \"error\" toast displaying the selected message",
|
| 11169 | "tags": [
|
| 11170 | {
|
| 11171 | "tag": "example",
|
| 11172 | "text": "\n\n```js\nconst message = prompt(\n 'Please insert a message:',\n 'This is an alert message!',\n);\n\nawait ctx.alert(message);\n```\n"
|
| 11173 | }
|
| 11174 | ]
|
| 11175 | },
|
| 11176 | "parameters": [
|
| 11177 | {
|
| 11178 | "id": 350,
|
| 11179 | "name": "message",
|
| 11180 | "kind": 32768,
|
| 11181 | "kindString": "Parameter",
|
| 11182 | "flags": {},
|
| 11183 | "type": {
|
| 11184 | "type": "intrinsic",
|
| 11185 | "name": "string"
|
| 11186 | }
|
| 11187 | }
|
| 11188 | ],
|
| 11189 | "type": {
|
| 11190 | "type": "reference",
|
| 11191 | "typeArguments": [
|
| 11192 | {
|
| 11193 | "type": "intrinsic",
|
| 11194 | "name": "void"
|
| 11195 | }
|
| 11196 | ],
|
| 11197 | "name": "Promise"
|
| 11198 | }
|
| 11199 | }
|
| 11200 | ]
|
| 11201 | },
|
| 11202 | {
|
| 11203 | "id": 354,
|
| 11204 | "name": "customToast",
|
| 11205 | "kind": 2048,
|
| 11206 | "kindString": "Method",
|
| 11207 | "flags": {},
|
| 11208 | "sources": [
|
| 11209 | {
|
| 11210 | "fileName": "types.ts",
|
| 11211 | "line": 773,
|
| 11212 | "character": 2
|
| 11213 | }
|
| 11214 | ],
|
| 11215 | "signatures": [
|
| 11216 | {
|
| 11217 | "id": 355,
|
| 11218 | "name": "customToast",
|
| 11219 | "kind": 4096,
|
| 11220 | "kindString": "Call signature",
|
| 11221 | "flags": {},
|
| 11222 | "comment": {
|
| 11223 | "shortText": "Triggers a custom toast displaying the selected message (and optionally a CTA)",
|
| 11224 | "tags": [
|
| 11225 | {
|
| 11226 | "tag": "example",
|
| 11227 | "text": "\n\n```js\nconst result = await ctx.customToast({\n type: 'warning',\n message: 'Just a sample warning notification!',\n dismissOnPageChange: true,\n dismissAfterTimeout: 5000,\n cta: {\n label: 'Execute call-to-action',\n value: 'cta',\n },\n});\n\nif (result === 'cta') {\n ctx.notice(`Clicked CTA!`);\n}\n```\n"
|
| 11228 | }
|
| 11229 | ]
|
| 11230 | },
|
| 11231 | "typeParameter": [
|
| 11232 | {
|
| 11233 | "id": 356,
|
| 11234 | "name": "CtaValue",
|
| 11235 | "kind": 131072,
|
| 11236 | "kindString": "Type parameter",
|
| 11237 | "flags": {},
|
| 11238 | "default": {
|
| 11239 | "type": "intrinsic",
|
| 11240 | "name": "unknown"
|
| 11241 | }
|
| 11242 | }
|
| 11243 | ],
|
| 11244 | "parameters": [
|
| 11245 | {
|
| 11246 | "id": 357,
|
| 11247 | "name": "toast",
|
| 11248 | "kind": 32768,
|
| 11249 | "kindString": "Parameter",
|
| 11250 | "flags": {},
|
| 11251 | "type": {
|
| 11252 | "type": "reference",
|
| 11253 | "id": 230,
|
| 11254 | "typeArguments": [
|
| 11255 | {
|
| 11256 | "type": "reference",
|
| 11257 | "id": 356,
|
| 11258 | "name": "CtaValue"
|
| 11259 | }
|
| 11260 | ],
|
| 11261 | "name": "Toast"
|
| 11262 | }
|
| 11263 | }
|
| 11264 | ],
|
| 11265 | "type": {
|
| 11266 | "type": "reference",
|
| 11267 | "typeArguments": [
|
| 11268 | {
|
| 11269 | "type": "union",
|
| 11270 | "types": [
|
| 11271 | {
|
| 11272 | "type": "literal",
|
| 11273 | "value": null
|
| 11274 | },
|
| 11275 | {
|
| 11276 | "type": "reference",
|
| 11277 | "id": 356,
|
| 11278 | "name": "CtaValue"
|
| 11279 | }
|
| 11280 | ]
|
| 11281 | }
|
| 11282 | ],
|
| 11283 | "name": "Promise"
|
| 11284 | }
|
| 11285 | }
|
| 11286 | ]
|
| 11287 | },
|
| 11288 | {
|
| 11289 | "id": 351,
|
| 11290 | "name": "notice",
|
| 11291 | "kind": 2048,
|
| 11292 | "kindString": "Method",
|
| 11293 | "flags": {},
|
| 11294 | "sources": [
|
| 11295 | {
|
| 11296 | "fileName": "types.ts",
|
| 11297 | "line": 750,
|
| 11298 | "character": 2
|
| 11299 | }
|
| 11300 | ],
|
| 11301 | "signatures": [
|
| 11302 | {
|
| 11303 | "id": 352,
|
| 11304 | "name": "notice",
|
| 11305 | "kind": 4096,
|
| 11306 | "kindString": "Call signature",
|
| 11307 | "flags": {},
|
| 11308 | "comment": {
|
| 11309 | "shortText": "Triggers a \"success\" toast displaying the selected message",
|
| 11310 | "tags": [
|
| 11311 | {
|
| 11312 | "tag": "example",
|
| 11313 | "text": "\n\n```js\nconst message = prompt(\n 'Please insert a message:',\n 'This is a notice message!',\n);\n\nawait ctx.notice(message);\n```\n"
|
| 11314 | }
|
| 11315 | ]
|
| 11316 | },
|
| 11317 | "parameters": [
|
| 11318 | {
|
| 11319 | "id": 353,
|
| 11320 | "name": "message",
|
| 11321 | "kind": 32768,
|
| 11322 | "kindString": "Parameter",
|
| 11323 | "flags": {},
|
| 11324 | "type": {
|
| 11325 | "type": "intrinsic",
|
| 11326 | "name": "string"
|
| 11327 | }
|
| 11328 | }
|
| 11329 | ],
|
| 11330 | "type": {
|
| 11331 | "type": "reference",
|
| 11332 | "typeArguments": [
|
| 11333 | {
|
| 11334 | "type": "intrinsic",
|
| 11335 | "name": "void"
|
| 11336 | }
|
| 11337 | ],
|
| 11338 | "name": "Promise"
|
| 11339 | }
|
| 11340 | }
|
| 11341 | ]
|
| 11342 | }
|
| 11343 | ],
|
| 11344 | "groups": [
|
| 11345 | {
|
| 11346 | "title": "Methods",
|
| 11347 | "kind": 2048,
|
| 11348 | "children": [
|
| 11349 | 348,
|
| 11350 | 354,
|
| 11351 | 351
|
| 11352 | ]
|
| 11353 | }
|
| 11354 | ],
|
| 11355 | "sources": [
|
| 11356 | {
|
| 11357 | "fileName": "types.ts",
|
| 11358 | "line": 720,
|
| 11359 | "character": 27
|
| 11360 | }
|
| 11361 | ]
|
| 11362 | }
|
| 11363 | }
|
| 11364 | },
|
| 11365 | {
|
| 11366 | "id": 306,
|
| 11367 | "name": "UpdateParametersMethods",
|
| 11368 | "kind": 4194304,
|
| 11369 | "kindString": "Type alias",
|
| 11370 | "flags": {},
|
| 11371 | "comment": {
|
| 11372 | "shortText": "These methods can be used to update both plugin parameters and manual field\nextensions configuration."
|
| 11373 | },
|
| 11374 | "sources": [
|
| 11375 | {
|
| 11376 | "fileName": "types.ts",
|
| 11377 | "line": 510,
|
| 11378 | "character": 12
|
| 11379 | }
|
| 11380 | ],
|
| 11381 | "type": {
|
| 11382 | "type": "reflection",
|
| 11383 | "declaration": {
|
| 11384 | "id": 307,
|
| 11385 | "name": "__type",
|
| 11386 | "kind": 65536,
|
| 11387 | "kindString": "Type literal",
|
| 11388 | "flags": {},
|
| 11389 | "children": [
|
| 11390 | {
|
| 11391 | "id": 311,
|
| 11392 | "name": "updateFieldAppearance",
|
| 11393 | "kind": 2048,
|
| 11394 | "kindString": "Method",
|
| 11395 | "flags": {},
|
| 11396 | "sources": [
|
| 11397 | {
|
| 11398 | "fileName": "types.ts",
|
| 11399 | "line": 576,
|
| 11400 | "character": 2
|
| 11401 | }
|
| 11402 | ],
|
| 11403 | "signatures": [
|
| 11404 | {
|
| 11405 | "id": 312,
|
| 11406 | "name": "updateFieldAppearance",
|
| 11407 | "kind": 4096,
|
| 11408 | "kindString": "Call signature",
|
| 11409 | "flags": {},
|
| 11410 | "comment": {
|
| 11411 | "shortText": "Performs changes in the appearance of a field. You can install/remove a\nmanual field extension, or tweak their parameters. If multiple changes are\npassed, they will be applied sequencially.",
|
| 11412 | "text": "Always check `ctx.currentRole.meta.final_permissions.can_edit_schema`\nbefore calling this, as the user might not have the permission to perform\nthe operation.\n",
|
| 11413 | "tags": [
|
| 11414 | {
|
| 11415 | "tag": "example",
|
| 11416 | "text": "\n\n```js\nconst fields = await ctx.loadFieldsUsingPlugin();\n\nif (fields.length === 0) {\n ctx.alert('No field is using this plugin as a manual extension!');\n return;\n}\n\nfor (const field of fields) {\n const { appearance } = field.attributes;\n const operations = [];\n\n if (appearance.editor === ctx.plugin.id) {\n operations.push({\n operation: 'updateEditor',\n newParameters: {\n ...appearance.parameters,\n foo: 'bar',\n },\n });\n }\n\n appearance.addons.forEach((addon, i) => {\n if (addon.id !== ctx.plugin.id) {\n return;\n }\n\n operations.push({\n operation: 'updateAddon',\n index: i,\n newParameters: { ...addon.parameters, foo: 'bar' },\n });\n });\n\n await ctx.updateFieldAppearance(field.id, operations);\n ctx.notice(`Successfully edited field ${field.attributes.api_key}`);\n}\n```\n"
|
| 11417 | }
|
| 11418 | ]
|
| 11419 | },
|
| 11420 | "parameters": [
|
| 11421 | {
|
| 11422 | "id": 313,
|
| 11423 | "name": "fieldId",
|
| 11424 | "kind": 32768,
|
| 11425 | "kindString": "Parameter",
|
| 11426 | "flags": {},
|
| 11427 | "type": {
|
| 11428 | "type": "intrinsic",
|
| 11429 | "name": "string"
|
| 11430 | }
|
| 11431 | },
|
| 11432 | {
|
| 11433 | "id": 314,
|
| 11434 | "name": "changes",
|
| 11435 | "kind": 32768,
|
| 11436 | "kindString": "Parameter",
|
| 11437 | "flags": {},
|
| 11438 | "type": {
|
| 11439 | "type": "array",
|
| 11440 | "elementType": {
|
| 11441 | "type": "reference",
|
| 11442 | "id": 282,
|
| 11443 | "name": "FieldAppearanceChange"
|
| 11444 | }
|
| 11445 | }
|
| 11446 | }
|
| 11447 | ],
|
| 11448 | "type": {
|
| 11449 | "type": "reference",
|
| 11450 | "typeArguments": [
|
| 11451 | {
|
| 11452 | "type": "intrinsic",
|
| 11453 | "name": "void"
|
| 11454 | }
|
| 11455 | ],
|
| 11456 | "name": "Promise"
|
| 11457 | }
|
| 11458 | }
|
| 11459 | ]
|
| 11460 | },
|
| 11461 | {
|
| 11462 | "id": 308,
|
| 11463 | "name": "updatePluginParameters",
|
| 11464 | "kind": 2048,
|
| 11465 | "kindString": "Method",
|
| 11466 | "flags": {},
|
| 11467 | "sources": [
|
| 11468 | {
|
| 11469 | "fileName": "types.ts",
|
| 11470 | "line": 525,
|
| 11471 | "character": 2
|
| 11472 | }
|
| 11473 | ],
|
| 11474 | "signatures": [
|
| 11475 | {
|
| 11476 | "id": 309,
|
| 11477 | "name": "updatePluginParameters",
|
| 11478 | "kind": 4096,
|
| 11479 | "kindString": "Call signature",
|
| 11480 | "flags": {},
|
| 11481 | "comment": {
|
| 11482 | "shortText": "Updates the plugin parameters.",
|
| 11483 | "text": "Always check `ctx.currentRole.meta.final_permissions.can_edit_schema`\nbefore calling this, as the user might not have the permission to perform\nthe operation.\n",
|
| 11484 | "tags": [
|
| 11485 | {
|
| 11486 | "tag": "example",
|
| 11487 | "text": "\n\n```js\nawait ctx.updatePluginParameters({ debugMode: true });\nawait ctx.notice('Plugin parameters successfully updated!');\n```\n"
|
| 11488 | }
|
| 11489 | ]
|
| 11490 | },
|
| 11491 | "parameters": [
|
| 11492 | {
|
| 11493 | "id": 310,
|
| 11494 | "name": "params",
|
| 11495 | "kind": 32768,
|
| 11496 | "kindString": "Parameter",
|
| 11497 | "flags": {},
|
| 11498 | "type": {
|
| 11499 | "type": "reference",
|
| 11500 | "typeArguments": [
|
| 11501 | {
|
| 11502 | "type": "intrinsic",
|
| 11503 | "name": "string"
|
| 11504 | },
|
| 11505 | {
|
| 11506 | "type": "intrinsic",
|
| 11507 | "name": "unknown"
|
| 11508 | }
|
| 11509 | ],
|
| 11510 | "name": "Record"
|
| 11511 | }
|
| 11512 | }
|
| 11513 | ],
|
| 11514 | "type": {
|
| 11515 | "type": "reference",
|
| 11516 | "typeArguments": [
|
| 11517 | {
|
| 11518 | "type": "intrinsic",
|
| 11519 | "name": "void"
|
| 11520 | }
|
| 11521 | ],
|
| 11522 | "name": "Promise"
|
| 11523 | }
|
| 11524 | }
|
| 11525 | ]
|
| 11526 | }
|
| 11527 | ],
|
| 11528 | "groups": [
|
| 11529 | {
|
| 11530 | "title": "Methods",
|
| 11531 | "kind": 2048,
|
| 11532 | "children": [
|
| 11533 | 311,
|
| 11534 | 308
|
| 11535 | ]
|
| 11536 | }
|
| 11537 | ],
|
| 11538 | "sources": [
|
| 11539 | {
|
| 11540 | "fileName": "types.ts",
|
| 11541 | "line": 510,
|
| 11542 | "character": 38
|
| 11543 | }
|
| 11544 | ]
|
| 11545 | }
|
| 11546 | }
|
| 11547 | },
|
| 11548 | {
|
| 11549 | "id": 358,
|
| 11550 | "name": "UploadDialogMethods",
|
| 11551 | "kind": 4194304,
|
| 11552 | "kindString": "Type alias",
|
| 11553 | "flags": {},
|
| 11554 | "comment": {
|
| 11555 | "shortText": "These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets"
|
| 11556 | },
|
| 11557 | "sources": [
|
| 11558 | {
|
| 11559 | "fileName": "types.ts",
|
| 11560 | "line": 782,
|
| 11561 | "character": 12
|
| 11562 | }
|
| 11563 | ],
|
| 11564 | "type": {
|
| 11565 | "type": "reflection",
|
| 11566 | "declaration": {
|
| 11567 | "id": 359,
|
| 11568 | "name": "__type",
|
| 11569 | "kind": 65536,
|
| 11570 | "kindString": "Type literal",
|
| 11571 | "flags": {},
|
| 11572 | "children": [
|
| 11573 | {
|
| 11574 | "id": 360,
|
| 11575 | "name": "selectUpload",
|
| 11576 | "kind": 1024,
|
| 11577 | "kindString": "Property",
|
| 11578 | "flags": {},
|
| 11579 | "sources": [
|
| 11580 | {
|
| 11581 | "fileName": "types.ts",
|
| 11582 | "line": 800,
|
| 11583 | "character": 2
|
| 11584 | }
|
| 11585 | ],
|
| 11586 | "type": {
|
| 11587 | "type": "reflection",
|
| 11588 | "declaration": {
|
| 11589 | "id": 361,
|
| 11590 | "name": "__type",
|
| 11591 | "kind": 65536,
|
| 11592 | "kindString": "Type literal",
|
| 11593 | "flags": {},
|
| 11594 | "sources": [
|
| 11595 | {
|
| 11596 | "fileName": "types.ts",
|
| 11597 | "line": 800,
|
| 11598 | "character": 16
|
| 11599 | }
|
| 11600 | ],
|
| 11601 | "signatures": [
|
| 11602 | {
|
| 11603 | "id": 362,
|
| 11604 | "name": "__type",
|
| 11605 | "kind": 4096,
|
| 11606 | "kindString": "Call signature",
|
| 11607 | "flags": {},
|
| 11608 | "comment": {
|
| 11609 | "shortText": "Opens a dialog for selecting one (or multiple) existing asset(s). It\nreturns a promise resolved with the selected asset(s), or `null` if the\nuser closes the dialog without selecting any upload.",
|
| 11610 | "tags": [
|
| 11611 | {
|
| 11612 | "tag": "example",
|
| 11613 | "text": "\n\n```js\nconst item = await ctx.selectUpload({ multiple: false });\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 11614 | }
|
| 11615 | ]
|
| 11616 | },
|
| 11617 | "parameters": [
|
| 11618 | {
|
| 11619 | "id": 363,
|
| 11620 | "name": "options",
|
| 11621 | "kind": 32768,
|
| 11622 | "kindString": "Parameter",
|
| 11623 | "flags": {},
|
| 11624 | "type": {
|
| 11625 | "type": "reflection",
|
| 11626 | "declaration": {
|
| 11627 | "id": 364,
|
| 11628 | "name": "__type",
|
| 11629 | "kind": 65536,
|
| 11630 | "kindString": "Type literal",
|
| 11631 | "flags": {},
|
| 11632 | "children": [
|
| 11633 | {
|
| 11634 | "id": 365,
|
| 11635 | "name": "multiple",
|
| 11636 | "kind": 1024,
|
| 11637 | "kindString": "Property",
|
| 11638 | "flags": {},
|
| 11639 | "sources": [
|
| 11640 | {
|
| 11641 | "fileName": "types.ts",
|
| 11642 | "line": 801,
|
| 11643 | "character": 16
|
| 11644 | }
|
| 11645 | ],
|
| 11646 | "type": {
|
| 11647 | "type": "literal",
|
| 11648 | "value": true
|
| 11649 | }
|
| 11650 | }
|
| 11651 | ],
|
| 11652 | "groups": [
|
| 11653 | {
|
| 11654 | "title": "Properties",
|
| 11655 | "kind": 1024,
|
| 11656 | "children": [
|
| 11657 | 365
|
| 11658 | ]
|
| 11659 | }
|
| 11660 | ]
|
| 11661 | }
|
| 11662 | }
|
| 11663 | }
|
| 11664 | ],
|
| 11665 | "type": {
|
| 11666 | "type": "reference",
|
| 11667 | "typeArguments": [
|
| 11668 | {
|
| 11669 | "type": "union",
|
| 11670 | "types": [
|
| 11671 | {
|
| 11672 | "type": "literal",
|
| 11673 | "value": null
|
| 11674 | },
|
| 11675 | {
|
| 11676 | "type": "array",
|
| 11677 | "elementType": {
|
| 11678 | "type": "reference",
|
| 11679 | "id": 37,
|
| 11680 | "name": "Upload"
|
| 11681 | }
|
| 11682 | }
|
| 11683 | ]
|
| 11684 | }
|
| 11685 | ],
|
| 11686 | "name": "Promise"
|
| 11687 | }
|
| 11688 | },
|
| 11689 | {
|
| 11690 | "id": 366,
|
| 11691 | "name": "__type",
|
| 11692 | "kind": 4096,
|
| 11693 | "kindString": "Call signature",
|
| 11694 | "flags": {},
|
| 11695 | "comment": {
|
| 11696 | "shortText": "Opens a dialog for selecting one (or multiple) existing asset(s). It\nreturns a promise resolved with the selected asset(s), or `null` if the\nuser closes the dialog without selecting any upload.",
|
| 11697 | "tags": [
|
| 11698 | {
|
| 11699 | "tag": "example",
|
| 11700 | "text": "\n\n```js\nconst item = await ctx.selectUpload({ multiple: false });\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 11701 | }
|
| 11702 | ]
|
| 11703 | },
|
| 11704 | "parameters": [
|
| 11705 | {
|
| 11706 | "id": 367,
|
| 11707 | "name": "options",
|
| 11708 | "kind": 32768,
|
| 11709 | "kindString": "Parameter",
|
| 11710 | "flags": {
|
| 11711 | "isOptional": true
|
| 11712 | },
|
| 11713 | "type": {
|
| 11714 | "type": "reflection",
|
| 11715 | "declaration": {
|
| 11716 | "id": 368,
|
| 11717 | "name": "__type",
|
| 11718 | "kind": 65536,
|
| 11719 | "kindString": "Type literal",
|
| 11720 | "flags": {},
|
| 11721 | "children": [
|
| 11722 | {
|
| 11723 | "id": 369,
|
| 11724 | "name": "multiple",
|
| 11725 | "kind": 1024,
|
| 11726 | "kindString": "Property",
|
| 11727 | "flags": {},
|
| 11728 | "sources": [
|
| 11729 | {
|
| 11730 | "fileName": "types.ts",
|
| 11731 | "line": 802,
|
| 11732 | "character": 17
|
| 11733 | }
|
| 11734 | ],
|
| 11735 | "type": {
|
| 11736 | "type": "literal",
|
| 11737 | "value": false
|
| 11738 | }
|
| 11739 | }
|
| 11740 | ],
|
| 11741 | "groups": [
|
| 11742 | {
|
| 11743 | "title": "Properties",
|
| 11744 | "kind": 1024,
|
| 11745 | "children": [
|
| 11746 | 369
|
| 11747 | ]
|
| 11748 | }
|
| 11749 | ]
|
| 11750 | }
|
| 11751 | }
|
| 11752 | }
|
| 11753 | ],
|
| 11754 | "type": {
|
| 11755 | "type": "reference",
|
| 11756 | "typeArguments": [
|
| 11757 | {
|
| 11758 | "type": "union",
|
| 11759 | "types": [
|
| 11760 | {
|
| 11761 | "type": "literal",
|
| 11762 | "value": null
|
| 11763 | },
|
| 11764 | {
|
| 11765 | "type": "reference",
|
| 11766 | "id": 37,
|
| 11767 | "name": "Upload"
|
| 11768 | }
|
| 11769 | ]
|
| 11770 | }
|
| 11771 | ],
|
| 11772 | "name": "Promise"
|
| 11773 | }
|
| 11774 | }
|
| 11775 | ]
|
| 11776 | }
|
| 11777 | }
|
| 11778 | },
|
| 11779 | {
|
| 11780 | "id": 370,
|
| 11781 | "name": "editUpload",
|
| 11782 | "kind": 2048,
|
| 11783 | "kindString": "Method",
|
| 11784 | "flags": {},
|
| 11785 | "sources": [
|
| 11786 | {
|
| 11787 | "fileName": "types.ts",
|
| 11788 | "line": 827,
|
| 11789 | "character": 2
|
| 11790 | }
|
| 11791 | ],
|
| 11792 | "signatures": [
|
| 11793 | {
|
| 11794 | "id": 371,
|
| 11795 | "name": "editUpload",
|
| 11796 | "kind": 4096,
|
| 11797 | "kindString": "Call signature",
|
| 11798 | "flags": {},
|
| 11799 | "comment": {
|
| 11800 | "shortText": "Opens a dialog for editing a Media Area asset. It returns a promise resolved with:",
|
| 11801 | "text": "- The updated asset, if the user persists some changes to the asset itself\n- `null`, if the user closes the dialog without persisting any change\n- An asset structure with an additional `deleted` property set to true, if\n the user deletes the asset\n",
|
| 11802 | "tags": [
|
| 11803 | {
|
| 11804 | "tag": "example",
|
| 11805 | "text": "\n\n```js\nconst uploadId = prompt('Please insert an asset ID:');\n\nconst item = await ctx.editUpload(uploadId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 11806 | }
|
| 11807 | ]
|
| 11808 | },
|
| 11809 | "parameters": [
|
| 11810 | {
|
| 11811 | "id": 372,
|
| 11812 | "name": "uploadId",
|
| 11813 | "kind": 32768,
|
| 11814 | "kindString": "Parameter",
|
| 11815 | "flags": {},
|
| 11816 | "type": {
|
| 11817 | "type": "intrinsic",
|
| 11818 | "name": "string"
|
| 11819 | }
|
| 11820 | }
|
| 11821 | ],
|
| 11822 | "type": {
|
| 11823 | "type": "reference",
|
| 11824 | "typeArguments": [
|
| 11825 | {
|
| 11826 | "type": "union",
|
| 11827 | "types": [
|
| 11828 | {
|
| 11829 | "type": "literal",
|
| 11830 | "value": null
|
| 11831 | },
|
| 11832 | {
|
| 11833 | "type": "intersection",
|
| 11834 | "types": [
|
| 11835 | {
|
| 11836 | "type": "reference",
|
| 11837 | "id": 37,
|
| 11838 | "name": "Upload"
|
| 11839 | },
|
| 11840 | {
|
| 11841 | "type": "reflection",
|
| 11842 | "declaration": {
|
| 11843 | "id": 373,
|
| 11844 | "name": "__type",
|
| 11845 | "kind": 65536,
|
| 11846 | "kindString": "Type literal",
|
| 11847 | "flags": {},
|
| 11848 | "children": [
|
| 11849 | {
|
| 11850 | "id": 374,
|
| 11851 | "name": "deleted",
|
| 11852 | "kind": 1024,
|
| 11853 | "kindString": "Property",
|
| 11854 | "flags": {
|
| 11855 | "isOptional": true
|
| 11856 | },
|
| 11857 | "sources": [
|
| 11858 | {
|
| 11859 | "fileName": "types.ts",
|
| 11860 | "line": 829,
|
| 11861 | "character": 27
|
| 11862 | }
|
| 11863 | ],
|
| 11864 | "type": {
|
| 11865 | "type": "literal",
|
| 11866 | "value": true
|
| 11867 | }
|
| 11868 | }
|
| 11869 | ],
|
| 11870 | "groups": [
|
| 11871 | {
|
| 11872 | "title": "Properties",
|
| 11873 | "kind": 1024,
|
| 11874 | "children": [
|
| 11875 | 374
|
| 11876 | ]
|
| 11877 | }
|
| 11878 | ]
|
| 11879 | }
|
| 11880 | }
|
| 11881 | ]
|
| 11882 | }
|
| 11883 | ]
|
| 11884 | }
|
| 11885 | ],
|
| 11886 | "name": "Promise"
|
| 11887 | }
|
| 11888 | }
|
| 11889 | ]
|
| 11890 | },
|
| 11891 | {
|
| 11892 | "id": 375,
|
| 11893 | "name": "editUploadMetadata",
|
| 11894 | "kind": 2048,
|
| 11895 | "kindString": "Method",
|
| 11896 | "flags": {},
|
| 11897 | "sources": [
|
| 11898 | {
|
| 11899 | "fileName": "types.ts",
|
| 11900 | "line": 855,
|
| 11901 | "character": 2
|
| 11902 | }
|
| 11903 | ],
|
| 11904 | "signatures": [
|
| 11905 | {
|
| 11906 | "id": 376,
|
| 11907 | "name": "editUploadMetadata",
|
| 11908 | "kind": 4096,
|
| 11909 | "kindString": "Call signature",
|
| 11910 | "flags": {},
|
| 11911 | "comment": {
|
| 11912 | "shortText": "Opens a dialog for editing a \"single asset\" field structure. It returns a\npromise resolved with the updated structure, or `null` if the user closes\nthe dialog without persisting any change.",
|
| 11913 | "tags": [
|
| 11914 | {
|
| 11915 | "tag": "example",
|
| 11916 | "text": "\n\n```js\nconst uploadId = prompt('Please insert an asset ID:');\n\nconst result = await ctx.editUploadMetadata({\n upload_id: uploadId,\n alt: null,\n title: null,\n custom_data: {},\n focal_point: null,\n});\n\nif (result) {\n ctx.notice(`Success! ${JSON.stringify(result)}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
|
| 11917 | }
|
| 11918 | ]
|
| 11919 | },
|
| 11920 | "parameters": [
|
| 11921 | {
|
| 11922 | "id": 377,
|
| 11923 | "name": "fileFieldValue",
|
| 11924 | "kind": 32768,
|
| 11925 | "kindString": "Parameter",
|
| 11926 | "flags": {},
|
| 11927 | "type": {
|
| 11928 | "type": "reference",
|
| 11929 | "id": 215,
|
| 11930 | "name": "FileFieldValue"
|
| 11931 | }
|
| 11932 | },
|
| 11933 | {
|
| 11934 | "id": 378,
|
| 11935 | "name": "locale",
|
| 11936 | "kind": 32768,
|
| 11937 | "kindString": "Parameter",
|
| 11938 | "flags": {
|
| 11939 | "isOptional": true
|
| 11940 | },
|
| 11941 | "type": {
|
| 11942 | "type": "intrinsic",
|
| 11943 | "name": "string"
|
| 11944 | }
|
| 11945 | }
|
| 11946 | ],
|
| 11947 | "type": {
|
| 11948 | "type": "reference",
|
| 11949 | "typeArguments": [
|
| 11950 | {
|
| 11951 | "type": "union",
|
| 11952 | "types": [
|
| 11953 | {
|
| 11954 | "type": "literal",
|
| 11955 | "value": null
|
| 11956 | },
|
| 11957 | {
|
| 11958 | "type": "reference",
|
| 11959 | "id": 215,
|
| 11960 | "name": "FileFieldValue"
|
| 11961 | }
|
| 11962 | ]
|
| 11963 | }
|
| 11964 | ],
|
| 11965 | "name": "Promise"
|
| 11966 | }
|
| 11967 | }
|
| 11968 | ]
|
| 11969 | }
|
| 11970 | ],
|
| 11971 | "groups": [
|
| 11972 | {
|
| 11973 | "title": "Properties",
|
| 11974 | "kind": 1024,
|
| 11975 | "children": [
|
| 11976 | 360
|
| 11977 | ]
|
| 11978 | },
|
| 11979 | {
|
| 11980 | "title": "Methods",
|
| 11981 | "kind": 2048,
|
| 11982 | "children": [
|
| 11983 | 370,
|
| 11984 | 375
|
| 11985 | ]
|
| 11986 | }
|
| 11987 | ],
|
| 11988 | "sources": [
|
| 11989 | {
|
| 11990 | "fileName": "types.ts",
|
| 11991 | "line": 782,
|
| 11992 | "character": 34
|
| 11993 | }
|
| 11994 | ]
|
| 11995 | }
|
| 11996 | }
|
| 11997 | },
|
| 11998 | {
|
| 11999 | "id": 54,
|
| 12000 | "name": "connect",
|
| 12001 | "kind": 64,
|
| 12002 | "kindString": "Function",
|
| 12003 | "flags": {},
|
| 12004 | "sources": [
|
| 12005 | {
|
| 12006 | "fileName": "connect.ts",
|
| 12007 | "line": 270,
|
| 12008 | "character": 22
|
| 12009 | }
|
| 12010 | ],
|
| 12011 | "signatures": [
|
| 12012 | {
|
| 12013 | "id": 55,
|
| 12014 | "name": "connect",
|
| 12015 | "kind": 4096,
|
| 12016 | "kindString": "Call signature",
|
| 12017 | "flags": {},
|
| 12018 | "parameters": [
|
| 12019 | {
|
| 12020 | "id": 56,
|
| 12021 | "name": "configuration",
|
| 12022 | "kind": 32768,
|
| 12023 | "kindString": "Parameter",
|
| 12024 | "flags": {},
|
| 12025 | "type": {
|
| 12026 | "type": "reference",
|
| 12027 | "typeArguments": [
|
| 12028 | {
|
| 12029 | "type": "reference",
|
| 12030 | "id": 77,
|
| 12031 | "name": "FullConnectParameters"
|
| 12032 | }
|
| 12033 | ],
|
| 12034 | "name": "Partial"
|
| 12035 | },
|
| 12036 | "defaultValue": "{}"
|
| 12037 | }
|
| 12038 | ],
|
| 12039 | "type": {
|
| 12040 | "type": "reference",
|
| 12041 | "typeArguments": [
|
| 12042 | {
|
| 12043 | "type": "intrinsic",
|
| 12044 | "name": "void"
|
| 12045 | }
|
| 12046 | ],
|
| 12047 | "name": "Promise"
|
| 12048 | }
|
| 12049 | }
|
| 12050 | ]
|
| 12051 | }
|
| 12052 | ],
|
| 12053 | "groups": [
|
| 12054 | {
|
| 12055 | "title": "Interfaces",
|
| 12056 | "kind": 256,
|
| 12057 | "children": [
|
| 12058 | 1,
|
| 12059 | 5,
|
| 12060 | 10,
|
| 12061 | 16,
|
| 12062 | 21,
|
| 12063 | 48,
|
| 12064 | 26,
|
| 12065 | 31,
|
| 12066 | 37,
|
| 12067 | 42
|
| 12068 | ]
|
| 12069 | },
|
| 12070 | {
|
| 12071 | "title": "Type aliases",
|
| 12072 | "kind": 4194304,
|
| 12073 | "children": [
|
| 12074 | 194,
|
| 12075 | 252,
|
| 12076 | 241,
|
| 12077 | 246,
|
| 12078 | 151,
|
| 12079 | 379,
|
| 12080 | 184,
|
| 12081 | 282,
|
| 12082 | 200,
|
| 12083 | 160,
|
| 12084 | 68,
|
| 12085 | 215,
|
| 12086 | 211,
|
| 12087 | 77,
|
| 12088 | 392,
|
| 12089 | 264,
|
| 12090 | 268,
|
| 12091 | 267,
|
| 12092 | 272,
|
| 12093 | 66,
|
| 12094 | 326,
|
| 12095 | 408,
|
| 12096 | 398,
|
| 12097 | 428,
|
| 12098 | 407,
|
| 12099 | 175,
|
| 12100 | 174,
|
| 12101 | 315,
|
| 12102 | 129,
|
| 12103 | 161,
|
| 12104 | 222,
|
| 12105 | 387,
|
| 12106 | 530,
|
| 12107 | 526,
|
| 12108 | 67,
|
| 12109 | 534,
|
| 12110 | 529,
|
| 12111 | 535,
|
| 12112 | 484,
|
| 12113 | 273,
|
| 12114 | 520,
|
| 12115 | 516,
|
| 12116 | 76,
|
| 12117 | 524,
|
| 12118 | 519,
|
| 12119 | 525,
|
| 12120 | 452,
|
| 12121 | 441,
|
| 12122 | 74,
|
| 12123 | 456,
|
| 12124 | 451,
|
| 12125 | 457,
|
| 12126 | 73,
|
| 12127 | 507,
|
| 12128 | 498,
|
| 12129 | 75,
|
| 12130 | 514,
|
| 12131 | 506,
|
| 12132 | 515,
|
| 12133 | 397,
|
| 12134 | 464,
|
| 12135 | 458,
|
| 12136 | 72,
|
| 12137 | 471,
|
| 12138 | 463,
|
| 12139 | 472,
|
| 12140 | 478,
|
| 12141 | 473,
|
| 12142 | 71,
|
| 12143 | 482,
|
| 12144 | 477,
|
| 12145 | 483,
|
| 12146 | 281,
|
| 12147 | 440,
|
| 12148 | 435,
|
| 12149 | 429,
|
| 12150 | 439,
|
| 12151 | 434,
|
| 12152 | 138,
|
| 12153 | 145,
|
| 12154 | 57,
|
| 12155 | 204,
|
| 12156 | 230,
|
| 12157 | 346,
|
| 12158 | 306,
|
| 12159 | 358
|
| 12160 | ]
|
| 12161 | },
|
| 12162 | {
|
| 12163 | "title": "Functions",
|
| 12164 | "kind": 64,
|
| 12165 | "children": [
|
| 12166 | 54
|
| 12167 | ]
|
| 12168 | }
|
| 12169 | ],
|
| 12170 | "sources": [
|
| 12171 | {
|
| 12172 | "fileName": "index.ts",
|
| 12173 | "line": 1,
|
| 12174 | "character": 0
|
| 12175 | }
|
| 12176 | ]
|
| 12177 | } |
| \ | No newline at end of file |