lucid-extension-sdk 0.0.443 → 0.0.445

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. package/commandtypes.d.ts +16 -12
  2. package/core/cardintegration/cardfielddisplaysettings.d.ts +24 -440
  3. package/core/cardintegration/cardfielddisplaysettings.js +10 -0
  4. package/core/cardintegration/cardintegrationautosyncconfig.d.ts +6 -5
  5. package/core/cardintegration/cardintegrationautosyncconfig.js +1 -0
  6. package/core/cardintegration/cardintegrationconfig.d.ts +9 -437
  7. package/core/cardintegration/cardintegrationparams.d.ts +2 -2
  8. package/core/cardintegration/cardpaneltabs/tab.d.ts +1 -1
  9. package/core/cardintegration/cardpaneltabs/tabs/listtab.d.ts +1 -1
  10. package/core/cardintegration/cardpaneltabs/tabs.d.ts +4 -4
  11. package/core/cardintegration/extensiondatapanel/extensiondatapanellistitem.d.ts +10 -10
  12. package/core/cardintegration/extensiondatapanel/extensiondatapanellistitemtag.d.ts +2 -2
  13. package/core/cardintegration/extensiondatapanel/extensiondatapanellistitemusertag.d.ts +1 -1
  14. package/core/cardintegration/lucidcardintegration.d.ts +21 -13
  15. package/core/cardintegration/lucidcardintegrationcustomimportmodal.d.ts +3 -2
  16. package/core/cardintegration/lucidcardintegrationregistry.d.ts +1 -0
  17. package/core/cardintegration/lucidcardintegrationregistry.js +24 -1
  18. package/core/cardintegration/lucidcardintegrationstandardimportmodal.d.ts +2 -2
  19. package/core/cardintegration/useritemeditpermissions.d.ts +1 -1
  20. package/core/data/datasource/datasourceutils.d.ts +2 -2
  21. package/core/data/datasource/serializeddatasourceproperties.d.ts +2 -2
  22. package/core/data/datasource/serializedimporteddatasource.d.ts +6 -6
  23. package/core/data/datasource/sourceforeignkeys.d.ts +1 -1
  24. package/core/data/datasource/upstreamconfig.d.ts +2 -2
  25. package/core/data/fieldspecification.d.ts +4 -4
  26. package/core/data/fieldtypedefinition/basefieldtypedefinition.d.ts +5 -5
  27. package/core/data/fieldtypedefinition/collectionenumfieldtype.d.ts +2 -2
  28. package/core/data/fieldtypedefinition/fieldtypearray.d.ts +3 -3
  29. package/core/data/fieldtypedefinition/fieldtypedefinition.d.ts +1 -1
  30. package/core/data/fieldtypedefinition/lucidfields.d.ts +5 -1
  31. package/core/data/fieldtypedefinition/lucidfields.js +4 -0
  32. package/core/data/fieldtypedefinition/ndimensionalfieldtypearray.d.ts +1 -1
  33. package/core/data/fieldtypedefinition/semantickind.js +1 -1
  34. package/core/data/lucidicon.d.ts +1 -1
  35. package/core/data/referencekeys/serializedreferencekey.d.ts +2 -2
  36. package/core/data/serializedfield/serializeddataitems.d.ts +1 -1
  37. package/core/data/serializedfield/serializeddisplayoption.d.ts +1 -1
  38. package/core/data/serializedfield/serializedfielddefinition.d.ts +3 -3
  39. package/core/data/serializedfield/serializedschema.d.ts +1 -1
  40. package/core/format/format.d.ts +3 -3
  41. package/core/format/objectformat.d.ts +2 -2
  42. package/core/format/pointformat.d.ts +2 -2
  43. package/core/format/primitiveformat.d.ts +1 -1
  44. package/core/format/recordformat.d.ts +1 -1
  45. package/core/format/simpleformat.d.ts +1 -1
  46. package/core/guards.d.ts +1 -1
  47. package/core/importcardfromdetails/importcardfromdetails.d.ts +2 -2
  48. package/core/importcardfrompastedlink/importcardfrompastedlinkcallback.d.ts +1 -1
  49. package/core/iterable.d.ts +1 -1
  50. package/core/mutable.d.ts +1 -1
  51. package/core/primitivedata.d.ts +9 -8
  52. package/core/properties/datagraphic/staticdatagraphicsettings.d.ts +2 -2
  53. package/core/rules/serializedcondition.d.ts +1 -1
  54. package/core/rules/serializeddatagraphic.d.ts +1 -1
  55. package/core/rules/serializedeffect.d.ts +2 -2
  56. package/core/rules/serializedstencilgraphic.d.ts +1 -1
  57. package/core/sharedcardintegration/cardintegrationdefinitions.d.ts +69 -9
  58. package/core/sharedcardintegration/cardintegrationdefinitions.js +24 -1
  59. package/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts +5 -5
  60. package/core/unfurl/unfurlcallbacks.d.ts +1 -1
  61. package/core/unfurl/unfurldetails.d.ts +2 -2
  62. package/core/unfurl/unfurliframe.d.ts +1 -1
  63. package/core/validators/validators.d.ts +1 -1
  64. package/core/xhr.d.ts +2 -2
  65. package/data/collectiondefinition.d.ts +3 -3
  66. package/data/collectionproxy.d.ts +4 -3
  67. package/data/datasourceproxy.d.ts +2 -2
  68. package/data/displayoptiondefinition.d.ts +1 -1
  69. package/data/fieldconstraintdefinition.d.ts +1 -1
  70. package/data/referencekeydefinition.d.ts +3 -3
  71. package/data/referencekeyproxy.d.ts +3 -2
  72. package/data/schemadefinition.d.ts +10 -5
  73. package/data/schemadefinition.js +19 -1
  74. package/dataconnector/actions/action.d.ts +13 -1
  75. package/dataconnector/actions/action.js +10 -1
  76. package/dataconnector/actions/patch.d.ts +5 -5
  77. package/dataconnector/actions/patchresponsebody.d.ts +3 -3
  78. package/dataconnector/actions/serializedactions.d.ts +1 -1
  79. package/dataconnector/actions/serializedactions.js +8 -3
  80. package/dataconnector/actions/serializedpatchtypes.d.ts +1 -1
  81. package/dataconnector/dataconnector.d.ts +8 -7
  82. package/dataconnector/dataconnector.js +12 -5
  83. package/dataconnector/dataconnectorclient.d.ts +5 -4
  84. package/dataconnector/datasourceclient.d.ts +2 -2
  85. package/dataconnector/datasourceupdatetypes.d.ts +8 -8
  86. package/dataconnector/itemrekeyerandrelabeler.d.ts +1 -1
  87. package/dataconnector/signaturevalidator.d.ts +1 -1
  88. package/dataconnector/throwunsuccessful.d.ts +1 -1
  89. package/document/blockclasses/cardblockproxy.d.ts +1 -1
  90. package/document/blockclasses/linkunfurlblockproxy.d.ts +2 -2
  91. package/document/blockclasses/swimlaneblockproxy.d.ts +3 -3
  92. package/document/blockclasses/tableblockproxy.d.ts +3 -3
  93. package/document/blockdefinition.d.ts +3 -3
  94. package/document/blockproxy.d.ts +4 -4
  95. package/document/documentchunk.d.ts +1 -1
  96. package/document/documentelement/documentelementtype.d.ts +1 -0
  97. package/document/documentelement/documentelementtype.js +1 -0
  98. package/document/documentelement/ruleproxy.d.ts +2 -2
  99. package/document/documentproxy.d.ts +4 -4
  100. package/document/elementproxy.d.ts +1 -1
  101. package/document/graphdefinition.d.ts +1 -1
  102. package/document/imagedefinition.d.ts +3 -3
  103. package/document/itemproxy.d.ts +3 -3
  104. package/document/lineproxy.d.ts +3 -3
  105. package/document/pageproxy.d.ts +7 -7
  106. package/document/ruledefinition.d.ts +3 -3
  107. package/document/shapedataproxy.d.ts +2 -2
  108. package/document/text/textstyle.d.ts +2 -10
  109. package/editorclient.d.ts +8 -8
  110. package/message/importcardfrompastedlinkeventmessage.d.ts +1 -1
  111. package/message/unfurleventmessage.d.ts +1 -1
  112. package/package.json +1 -1
  113. package/ui/iframeui.d.ts +1 -1
package/commandtypes.d.ts CHANGED
@@ -1,18 +1,18 @@
1
- import { SerializedCardIntegrationConfig } from './core/cardintegration/cardintegrationconfig';
2
- import { SerializedFieldTypeDefinition } from './core/data/fieldtypedefinition/fieldtypedefinition';
3
- import { SerializedReferenceKeyType } from './core/data/referencekeys/serializedreferencekey';
4
- import { SerializedFieldType } from './core/data/serializedfield/serializedfields';
5
- import { JsonObject, UnsafeJsonSerializableOrUndefined } from './core/jsonserializable';
1
+ import type { SerializedCardIntegrationConfig } from './core/cardintegration/cardintegrationconfig';
2
+ import type { SerializedFieldTypeDefinition } from './core/data/fieldtypedefinition/fieldtypedefinition';
3
+ import type { SerializedReferenceKeyType } from './core/data/referencekeys/serializedreferencekey';
4
+ import type { SerializedFieldType } from './core/data/serializedfield/serializedfields';
5
+ import type { JsonObject, UnsafeJsonSerializableOrUndefined } from './core/jsonserializable';
6
6
  import { LucidProduct } from './core/lucidproduct';
7
- import { LinearOffsetType } from './core/offsettype';
8
- import { PartialAndNullish } from './core/partialandundefined';
9
- import { SerializedDataError } from './core/serializeddataerror';
7
+ import type { LinearOffsetType } from './core/offsettype';
8
+ import type { PartialAndNullish } from './core/partialandundefined';
9
+ import type { SerializedDataError } from './core/serializeddataerror';
10
10
  import { ShapeDataInheritance } from './core/shapedatainheritance';
11
11
  import { DocumentAccessPermission } from './document/documentaccesspermission';
12
12
  import { DocumentElementType } from './document/documentelement/documentelementtype';
13
- import { SerializedLineTextAreaPositioning } from './document/linetextareapositioning';
14
- import { TextStyle } from './document/text/textstyle';
15
- import { Box, Point } from './math';
13
+ import type { SerializedLineTextAreaPositioning } from './document/linetextareapositioning';
14
+ import type { TextStyle } from './document/text/textstyle';
15
+ import type { Box, Point } from './math';
16
16
  import { MenuLocation, MenuType } from './ui/menu';
17
17
  import { PanelLocation } from './ui/panel';
18
18
  /**
@@ -752,7 +752,6 @@ export type AddCardsActions = {
752
752
  'cc': string;
753
753
  };
754
754
  export type AutoSyncSettings = {
755
- 'h': string;
756
755
  /** Phrases */
757
756
  'p'?: {
758
757
  /** Header */
@@ -865,6 +864,11 @@ export type AddCardIntegrationQuery = {
865
864
  * Tag callback, to display tag information for any card
866
865
  */
867
866
  'tc'?: string | undefined;
867
+ /**
868
+ * @experimental
869
+ * Banner action callback, to handle action button clicks in import error banners
870
+ */
871
+ 'bac'?: string | undefined;
868
872
  /**
869
873
  * If specified, the text phrases to show in the dependency mapping UI.
870
874
  * If not specified, dependency mapping for this integration uses the default fallback phrases.
@@ -1,5 +1,5 @@
1
- import { FormatToDeserializedType, FormatToSerializedType } from '../format/format';
2
- import { DeepWritable } from '../mutable';
1
+ import { type FormatToDeserializedType, type FormatToSerializedType } from '../format/format';
2
+ import type { DeepWritable } from '../mutable';
3
3
  import { HorizontalBadgePos, VerticalBadgePos } from '../properties/datagraphic/badgeposition';
4
4
  /**
5
5
  * When configuring a field on a LucidCardBlock to be displayed as a data graphic, one of these values specifies
@@ -91,7 +91,12 @@ export declare enum OnClickHandlerKeys {
91
91
  /**
92
92
  * Display a panel on the canvas when a stencil is clicked, showing a list of items related to the stencil field
93
93
  */
94
- ListStencilPanel = "ListStencilPanel"
94
+ ListStencilPanel = "ListStencilPanel",
95
+ /**
96
+ * @experimental
97
+ * Open the right-hand card details panel and navigate to a specific target tab
98
+ */
99
+ OpenTargetTab = "OpenTargetTab"
95
100
  }
96
101
  export declare const isOnClickHandlerKey: (x: unknown) => x is OnClickHandlerKeys;
97
102
  declare const TextBadgeSettingsFormatter: import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
@@ -197,6 +202,11 @@ declare const StencilConfigFormatter: import("../format/format").Format<import("
197
202
  * If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
198
203
  */
199
204
  readonly linkFormula: readonly ["l", import("../format/format").Format<string | null | undefined, string | null | undefined>];
205
+ /**
206
+ * @experimental
207
+ * If onClickHandlerKey is OpenTargetTab, this specifies the label of the tab to open.
208
+ */
209
+ readonly targetTabLabel: readonly ["targetTabLabel", import("../format/format").Format<string | null | undefined, string | null | undefined>];
200
210
  /**
201
211
  * Allows the same card to have multiple textbadges but have different properties.
202
212
  * You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
@@ -238,6 +248,7 @@ declare const StencilConfigFormatter: import("../format/format").Format<import("
238
248
  readonly verticalPosition?: VerticalBadgePos | null | undefined;
239
249
  readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
240
250
  readonly linkFormula?: string | null | undefined;
251
+ readonly targetTabLabel?: string | null | undefined;
241
252
  readonly textBadgeSettings?: {
242
253
  readonly rounding?: number | null | undefined;
243
254
  readonly bold?: boolean | null | undefined;
@@ -324,6 +335,11 @@ export declare const CardFieldDisplaySettingsFormatter: import("../format/format
324
335
  * If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
325
336
  */
326
337
  readonly linkFormula: readonly ["l", import("../format/format").Format<string | null | undefined, string | null | undefined>];
338
+ /**
339
+ * @experimental
340
+ * If onClickHandlerKey is OpenTargetTab, this specifies the label of the tab to open.
341
+ */
342
+ readonly targetTabLabel: readonly ["targetTabLabel", import("../format/format").Format<string | null | undefined, string | null | undefined>];
327
343
  /**
328
344
  * Allows the same card to have multiple textbadges but have different properties.
329
345
  * You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
@@ -365,6 +381,7 @@ export declare const CardFieldDisplaySettingsFormatter: import("../format/format
365
381
  readonly verticalPosition?: VerticalBadgePos | null | undefined;
366
382
  readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
367
383
  readonly linkFormula?: string | null | undefined;
384
+ readonly targetTabLabel?: string | null | undefined;
368
385
  readonly textBadgeSettings?: {
369
386
  readonly rounding?: number | null | undefined;
370
387
  readonly bold?: boolean | null | undefined;
@@ -393,6 +410,7 @@ export declare const CardFieldDisplaySettingsFormatter: import("../format/format
393
410
  readonly verticalPosition?: VerticalBadgePos | null | undefined;
394
411
  readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
395
412
  readonly linkFormula?: string | null | undefined;
413
+ readonly targetTabLabel?: string | null | undefined;
396
414
  readonly textBadgeSettings?: {
397
415
  readonly rounding?: number | null | undefined;
398
416
  readonly bold?: boolean | null | undefined;
@@ -417,446 +435,12 @@ export type LucidCardFieldDisplaySettings = DeepWritable<FormatToDeserializedTyp
417
435
  /** @ignore */
418
436
  export type SerializedLucidCardFieldDisplaySettings = FormatToSerializedType<typeof CardFieldDisplaySettingsFormatter>;
419
437
  /** @ignore */
420
- export declare const isSerializedLucidCardFieldDisplaySettings: import("../guards").Validator<import("../format/objectformat").ObjectFormatSerializedType<{
421
- readonly stencilConfig: readonly ["StencilConfig", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
422
- /**
423
- * How should we generate the stencil/data graphic from the specified field value?
424
- * These are registered in LucidCardsLibrary.registerStencilDisplayTypes.
425
- *
426
- * The serialized key is `getterKey` for backwards compatible, legacy reasons. We have renamed this field in code,
427
- * but need to support the original serialized key.
428
- */
429
- readonly displayType: readonly ["getterKey", import("../format/format").Format<FieldDisplayType, FieldDisplayType>];
430
- /**
431
- * For displayType values that support it, you may provide an override for the
432
- * background color for this data. If this is not provided, the background color
433
- * will default to the background color of the card itself, darkened 5%.
434
- *
435
- * This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
436
- * by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
437
- */
438
- readonly backgroundColor: readonly ["bg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
439
- /**
440
- * For displayType values that support it, you may provide an override for the
441
- * foreground color for this data. If this is not provided, the foreground color
442
- * will default to grey.
443
- *
444
- * This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
445
- * by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
446
- */
447
- readonly foregroundColor: readonly ["fg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
448
- /**
449
- * For displayType values that support it, you may provide a height and a width
450
- * for the image size. Images are 24px by 24px by default.
451
- *
452
- */
453
- readonly imageBadgeSettings: readonly ["imageBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
454
- readonly height: readonly ["height", import("../format/format").Format<number, number>];
455
- readonly width: readonly ["width", import("../format/format").Format<number, number>];
456
- }> | null | undefined, {
457
- readonly height: number;
458
- readonly width: number;
459
- } | null | undefined>];
460
- /**
461
- * If specified, the result of this formula (executed in the context of the data item
462
- * associated with this card) will be used instead of the raw field value when
463
- * creating the data graphic. This can be useful if, for example, you want to convert
464
- * an ID into a URL.
465
- */
466
- readonly valueFormula: readonly ["f", import("../format/format").Format<string | null | undefined, string | null | undefined>];
467
- /**
468
- * If specified, the result of this formula (executed in the context of the data item
469
- * associated with this card) will be used as a tooltip when the user hovers the
470
- * cursor over this data graphic.
471
- */
472
- readonly tooltipFormula: readonly ["t", import("../format/format").Format<string | null | undefined, string | null | undefined>];
473
- /**
474
- * Each display type has its default location on the card. You can override those
475
- * default locations by setting these values.
476
- */
477
- readonly horizontalPosition: readonly ["h", import("../format/format").Format<HorizontalBadgePos | null | undefined, HorizontalBadgePos | null | undefined>];
478
- /**
479
- * Each display type has its default location on the card. You can override those
480
- * default locations by setting these values.
481
- */
482
- readonly verticalPosition: readonly ["v", import("../format/format").Format<VerticalBadgePos | null | undefined, VerticalBadgePos | null | undefined>];
483
- /**
484
- * If specified, what behavior should happen when the user clicks on the data graphic
485
- * generated via the above displayType?
486
- */
487
- readonly onClickHandlerKey: readonly ["onClickHandlerKey", import("../format/format").Format<OnClickHandlerKeys | null | undefined, OnClickHandlerKeys | null | undefined>];
488
- /**
489
- * If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
490
- */
491
- readonly linkFormula: readonly ["l", import("../format/format").Format<string | null | undefined, string | null | undefined>];
492
- /**
493
- * Allows the same card to have multiple textbadges but have different properties.
494
- * You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
495
- */
496
- readonly textBadgeSettings: readonly ["textBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
497
- readonly rounding: readonly ["rounding", import("../format/format").Format<number | null | undefined, number | null | undefined>];
498
- readonly bold: readonly ["bold", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
499
- readonly italic: readonly ["italic", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
500
- readonly underline: readonly ["underline", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
501
- readonly minwidth: readonly ["minwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
502
- readonly minheight: readonly ["minheight", import("../format/format").Format<number | null | undefined, number | null | undefined>];
503
- readonly maxfontsize: readonly ["maxfontsize", import("../format/format").Format<number | null | undefined, number | null | undefined>];
504
- readonly maxtextwidth: readonly ["maxtextwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
505
- readonly iswithinpill: readonly ["iswithinpill", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
506
- readonly hasleadingicon: readonly ["hasleadingicon", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
507
- }> | null | undefined, {
508
- readonly rounding?: number | null | undefined;
509
- readonly bold?: boolean | null | undefined;
510
- readonly italic?: boolean | null | undefined;
511
- readonly underline?: boolean | null | undefined;
512
- readonly minwidth?: number | null | undefined;
513
- readonly minheight?: number | null | undefined;
514
- readonly maxfontsize?: number | null | undefined;
515
- readonly maxtextwidth?: number | null | undefined;
516
- readonly iswithinpill?: boolean | null | undefined;
517
- readonly hasleadingicon?: boolean | null | undefined;
518
- } | null | undefined>];
519
- }> | null | undefined, {
520
- readonly displayType: FieldDisplayType;
521
- readonly backgroundColor?: string | null | undefined;
522
- readonly foregroundColor?: string | null | undefined;
523
- readonly imageBadgeSettings?: {
524
- readonly height: number;
525
- readonly width: number;
526
- } | null | undefined;
527
- readonly valueFormula?: string | null | undefined;
528
- readonly tooltipFormula?: string | null | undefined;
529
- readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
530
- readonly verticalPosition?: VerticalBadgePos | null | undefined;
531
- readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
532
- readonly linkFormula?: string | null | undefined;
533
- readonly textBadgeSettings?: {
534
- readonly rounding?: number | null | undefined;
535
- readonly bold?: boolean | null | undefined;
536
- readonly italic?: boolean | null | undefined;
537
- readonly underline?: boolean | null | undefined;
538
- readonly minwidth?: number | null | undefined;
539
- readonly minheight?: number | null | undefined;
540
- readonly maxfontsize?: number | null | undefined;
541
- readonly maxtextwidth?: number | null | undefined;
542
- readonly iswithinpill?: boolean | null | undefined;
543
- readonly hasleadingicon?: boolean | null | undefined;
544
- } | null | undefined;
545
- } | null | undefined>];
546
- }>>;
438
+ export declare const isSerializedLucidCardFieldDisplaySettings: typeof CardFieldDisplaySettingsFormatter.validator;
547
439
  export declare function copyLucidCardFieldDisplaySettings(settings: LucidCardFieldDisplaySettings): LucidCardFieldDisplaySettings;
548
440
  /** @ignore */
549
- export declare const serializeLucidCardFieldDisplaySettings: (x: {
550
- readonly stencilConfig?: {
551
- readonly displayType: FieldDisplayType;
552
- readonly backgroundColor?: string | null | undefined;
553
- readonly foregroundColor?: string | null | undefined;
554
- readonly imageBadgeSettings?: {
555
- readonly height: number;
556
- readonly width: number;
557
- } | null | undefined;
558
- readonly valueFormula?: string | null | undefined;
559
- readonly tooltipFormula?: string | null | undefined;
560
- readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
561
- readonly verticalPosition?: VerticalBadgePos | null | undefined;
562
- readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
563
- readonly linkFormula?: string | null | undefined;
564
- readonly textBadgeSettings?: {
565
- readonly rounding?: number | null | undefined;
566
- readonly bold?: boolean | null | undefined;
567
- readonly italic?: boolean | null | undefined;
568
- readonly underline?: boolean | null | undefined;
569
- readonly minwidth?: number | null | undefined;
570
- readonly minheight?: number | null | undefined;
571
- readonly maxfontsize?: number | null | undefined;
572
- readonly maxtextwidth?: number | null | undefined;
573
- readonly iswithinpill?: boolean | null | undefined;
574
- readonly hasleadingicon?: boolean | null | undefined;
575
- } | null | undefined;
576
- } | null | undefined;
577
- }) => import("../format/objectformat").ObjectFormatSerializedType<{
578
- readonly stencilConfig: readonly ["StencilConfig", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
579
- /**
580
- * How should we generate the stencil/data graphic from the specified field value?
581
- * These are registered in LucidCardsLibrary.registerStencilDisplayTypes.
582
- *
583
- * The serialized key is `getterKey` for backwards compatible, legacy reasons. We have renamed this field in code,
584
- * but need to support the original serialized key.
585
- */
586
- readonly displayType: readonly ["getterKey", import("../format/format").Format<FieldDisplayType, FieldDisplayType>];
587
- /**
588
- * For displayType values that support it, you may provide an override for the
589
- * background color for this data. If this is not provided, the background color
590
- * will default to the background color of the card itself, darkened 5%.
591
- *
592
- * This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
593
- * by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
594
- */
595
- readonly backgroundColor: readonly ["bg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
596
- /**
597
- * For displayType values that support it, you may provide an override for the
598
- * foreground color for this data. If this is not provided, the foreground color
599
- * will default to grey.
600
- *
601
- * This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
602
- * by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
603
- */
604
- readonly foregroundColor: readonly ["fg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
605
- /**
606
- * For displayType values that support it, you may provide a height and a width
607
- * for the image size. Images are 24px by 24px by default.
608
- *
609
- */
610
- readonly imageBadgeSettings: readonly ["imageBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
611
- readonly height: readonly ["height", import("../format/format").Format<number, number>];
612
- readonly width: readonly ["width", import("../format/format").Format<number, number>];
613
- }> | null | undefined, {
614
- readonly height: number;
615
- readonly width: number;
616
- } | null | undefined>];
617
- /**
618
- * If specified, the result of this formula (executed in the context of the data item
619
- * associated with this card) will be used instead of the raw field value when
620
- * creating the data graphic. This can be useful if, for example, you want to convert
621
- * an ID into a URL.
622
- */
623
- readonly valueFormula: readonly ["f", import("../format/format").Format<string | null | undefined, string | null | undefined>];
624
- /**
625
- * If specified, the result of this formula (executed in the context of the data item
626
- * associated with this card) will be used as a tooltip when the user hovers the
627
- * cursor over this data graphic.
628
- */
629
- readonly tooltipFormula: readonly ["t", import("../format/format").Format<string | null | undefined, string | null | undefined>];
630
- /**
631
- * Each display type has its default location on the card. You can override those
632
- * default locations by setting these values.
633
- */
634
- readonly horizontalPosition: readonly ["h", import("../format/format").Format<HorizontalBadgePos | null | undefined, HorizontalBadgePos | null | undefined>];
635
- /**
636
- * Each display type has its default location on the card. You can override those
637
- * default locations by setting these values.
638
- */
639
- readonly verticalPosition: readonly ["v", import("../format/format").Format<VerticalBadgePos | null | undefined, VerticalBadgePos | null | undefined>];
640
- /**
641
- * If specified, what behavior should happen when the user clicks on the data graphic
642
- * generated via the above displayType?
643
- */
644
- readonly onClickHandlerKey: readonly ["onClickHandlerKey", import("../format/format").Format<OnClickHandlerKeys | null | undefined, OnClickHandlerKeys | null | undefined>];
645
- /**
646
- * If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
647
- */
648
- readonly linkFormula: readonly ["l", import("../format/format").Format<string | null | undefined, string | null | undefined>];
649
- /**
650
- * Allows the same card to have multiple textbadges but have different properties.
651
- * You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
652
- */
653
- readonly textBadgeSettings: readonly ["textBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
654
- readonly rounding: readonly ["rounding", import("../format/format").Format<number | null | undefined, number | null | undefined>];
655
- readonly bold: readonly ["bold", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
656
- readonly italic: readonly ["italic", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
657
- readonly underline: readonly ["underline", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
658
- readonly minwidth: readonly ["minwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
659
- readonly minheight: readonly ["minheight", import("../format/format").Format<number | null | undefined, number | null | undefined>];
660
- readonly maxfontsize: readonly ["maxfontsize", import("../format/format").Format<number | null | undefined, number | null | undefined>];
661
- readonly maxtextwidth: readonly ["maxtextwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
662
- readonly iswithinpill: readonly ["iswithinpill", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
663
- readonly hasleadingicon: readonly ["hasleadingicon", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
664
- }> | null | undefined, {
665
- readonly rounding?: number | null | undefined;
666
- readonly bold?: boolean | null | undefined;
667
- readonly italic?: boolean | null | undefined;
668
- readonly underline?: boolean | null | undefined;
669
- readonly minwidth?: number | null | undefined;
670
- readonly minheight?: number | null | undefined;
671
- readonly maxfontsize?: number | null | undefined;
672
- readonly maxtextwidth?: number | null | undefined;
673
- readonly iswithinpill?: boolean | null | undefined;
674
- readonly hasleadingicon?: boolean | null | undefined;
675
- } | null | undefined>];
676
- }> | null | undefined, {
677
- readonly displayType: FieldDisplayType;
678
- readonly backgroundColor?: string | null | undefined;
679
- readonly foregroundColor?: string | null | undefined;
680
- readonly imageBadgeSettings?: {
681
- readonly height: number;
682
- readonly width: number;
683
- } | null | undefined;
684
- readonly valueFormula?: string | null | undefined;
685
- readonly tooltipFormula?: string | null | undefined;
686
- readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
687
- readonly verticalPosition?: VerticalBadgePos | null | undefined;
688
- readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
689
- readonly linkFormula?: string | null | undefined;
690
- readonly textBadgeSettings?: {
691
- readonly rounding?: number | null | undefined;
692
- readonly bold?: boolean | null | undefined;
693
- readonly italic?: boolean | null | undefined;
694
- readonly underline?: boolean | null | undefined;
695
- readonly minwidth?: number | null | undefined;
696
- readonly minheight?: number | null | undefined;
697
- readonly maxfontsize?: number | null | undefined;
698
- readonly maxtextwidth?: number | null | undefined;
699
- readonly iswithinpill?: boolean | null | undefined;
700
- readonly hasleadingicon?: boolean | null | undefined;
701
- } | null | undefined;
702
- } | null | undefined>];
703
- }>;
441
+ export declare const serializeLucidCardFieldDisplaySettings: typeof CardFieldDisplaySettingsFormatter.toJson;
704
442
  /** @ignore */
705
- export declare const deserializeLucidCardFieldDisplaySettings: (x: import("../format/objectformat").ObjectFormatSerializedType<{
706
- readonly stencilConfig: readonly ["StencilConfig", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
707
- /**
708
- * How should we generate the stencil/data graphic from the specified field value?
709
- * These are registered in LucidCardsLibrary.registerStencilDisplayTypes.
710
- *
711
- * The serialized key is `getterKey` for backwards compatible, legacy reasons. We have renamed this field in code,
712
- * but need to support the original serialized key.
713
- */
714
- readonly displayType: readonly ["getterKey", import("../format/format").Format<FieldDisplayType, FieldDisplayType>];
715
- /**
716
- * For displayType values that support it, you may provide an override for the
717
- * background color for this data. If this is not provided, the background color
718
- * will default to the background color of the card itself, darkened 5%.
719
- *
720
- * This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
721
- * by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
722
- */
723
- readonly backgroundColor: readonly ["bg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
724
- /**
725
- * For displayType values that support it, you may provide an override for the
726
- * foreground color for this data. If this is not provided, the foreground color
727
- * will default to grey.
728
- *
729
- * This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
730
- * by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
731
- */
732
- readonly foregroundColor: readonly ["fg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
733
- /**
734
- * For displayType values that support it, you may provide a height and a width
735
- * for the image size. Images are 24px by 24px by default.
736
- *
737
- */
738
- readonly imageBadgeSettings: readonly ["imageBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
739
- readonly height: readonly ["height", import("../format/format").Format<number, number>];
740
- readonly width: readonly ["width", import("../format/format").Format<number, number>];
741
- }> | null | undefined, {
742
- readonly height: number;
743
- readonly width: number;
744
- } | null | undefined>];
745
- /**
746
- * If specified, the result of this formula (executed in the context of the data item
747
- * associated with this card) will be used instead of the raw field value when
748
- * creating the data graphic. This can be useful if, for example, you want to convert
749
- * an ID into a URL.
750
- */
751
- readonly valueFormula: readonly ["f", import("../format/format").Format<string | null | undefined, string | null | undefined>];
752
- /**
753
- * If specified, the result of this formula (executed in the context of the data item
754
- * associated with this card) will be used as a tooltip when the user hovers the
755
- * cursor over this data graphic.
756
- */
757
- readonly tooltipFormula: readonly ["t", import("../format/format").Format<string | null | undefined, string | null | undefined>];
758
- /**
759
- * Each display type has its default location on the card. You can override those
760
- * default locations by setting these values.
761
- */
762
- readonly horizontalPosition: readonly ["h", import("../format/format").Format<HorizontalBadgePos | null | undefined, HorizontalBadgePos | null | undefined>];
763
- /**
764
- * Each display type has its default location on the card. You can override those
765
- * default locations by setting these values.
766
- */
767
- readonly verticalPosition: readonly ["v", import("../format/format").Format<VerticalBadgePos | null | undefined, VerticalBadgePos | null | undefined>];
768
- /**
769
- * If specified, what behavior should happen when the user clicks on the data graphic
770
- * generated via the above displayType?
771
- */
772
- readonly onClickHandlerKey: readonly ["onClickHandlerKey", import("../format/format").Format<OnClickHandlerKeys | null | undefined, OnClickHandlerKeys | null | undefined>];
773
- /**
774
- * If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
775
- */
776
- readonly linkFormula: readonly ["l", import("../format/format").Format<string | null | undefined, string | null | undefined>];
777
- /**
778
- * Allows the same card to have multiple textbadges but have different properties.
779
- * You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
780
- */
781
- readonly textBadgeSettings: readonly ["textBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
782
- readonly rounding: readonly ["rounding", import("../format/format").Format<number | null | undefined, number | null | undefined>];
783
- readonly bold: readonly ["bold", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
784
- readonly italic: readonly ["italic", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
785
- readonly underline: readonly ["underline", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
786
- readonly minwidth: readonly ["minwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
787
- readonly minheight: readonly ["minheight", import("../format/format").Format<number | null | undefined, number | null | undefined>];
788
- readonly maxfontsize: readonly ["maxfontsize", import("../format/format").Format<number | null | undefined, number | null | undefined>];
789
- readonly maxtextwidth: readonly ["maxtextwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
790
- readonly iswithinpill: readonly ["iswithinpill", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
791
- readonly hasleadingicon: readonly ["hasleadingicon", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
792
- }> | null | undefined, {
793
- readonly rounding?: number | null | undefined;
794
- readonly bold?: boolean | null | undefined;
795
- readonly italic?: boolean | null | undefined;
796
- readonly underline?: boolean | null | undefined;
797
- readonly minwidth?: number | null | undefined;
798
- readonly minheight?: number | null | undefined;
799
- readonly maxfontsize?: number | null | undefined;
800
- readonly maxtextwidth?: number | null | undefined;
801
- readonly iswithinpill?: boolean | null | undefined;
802
- readonly hasleadingicon?: boolean | null | undefined;
803
- } | null | undefined>];
804
- }> | null | undefined, {
805
- readonly displayType: FieldDisplayType;
806
- readonly backgroundColor?: string | null | undefined;
807
- readonly foregroundColor?: string | null | undefined;
808
- readonly imageBadgeSettings?: {
809
- readonly height: number;
810
- readonly width: number;
811
- } | null | undefined;
812
- readonly valueFormula?: string | null | undefined;
813
- readonly tooltipFormula?: string | null | undefined;
814
- readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
815
- readonly verticalPosition?: VerticalBadgePos | null | undefined;
816
- readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
817
- readonly linkFormula?: string | null | undefined;
818
- readonly textBadgeSettings?: {
819
- readonly rounding?: number | null | undefined;
820
- readonly bold?: boolean | null | undefined;
821
- readonly italic?: boolean | null | undefined;
822
- readonly underline?: boolean | null | undefined;
823
- readonly minwidth?: number | null | undefined;
824
- readonly minheight?: number | null | undefined;
825
- readonly maxfontsize?: number | null | undefined;
826
- readonly maxtextwidth?: number | null | undefined;
827
- readonly iswithinpill?: boolean | null | undefined;
828
- readonly hasleadingicon?: boolean | null | undefined;
829
- } | null | undefined;
830
- } | null | undefined>];
831
- }>) => {
832
- readonly stencilConfig?: {
833
- readonly displayType: FieldDisplayType;
834
- readonly backgroundColor?: string | null | undefined;
835
- readonly foregroundColor?: string | null | undefined;
836
- readonly imageBadgeSettings?: {
837
- readonly height: number;
838
- readonly width: number;
839
- } | null | undefined;
840
- readonly valueFormula?: string | null | undefined;
841
- readonly tooltipFormula?: string | null | undefined;
842
- readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
843
- readonly verticalPosition?: VerticalBadgePos | null | undefined;
844
- readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
845
- readonly linkFormula?: string | null | undefined;
846
- readonly textBadgeSettings?: {
847
- readonly rounding?: number | null | undefined;
848
- readonly bold?: boolean | null | undefined;
849
- readonly italic?: boolean | null | undefined;
850
- readonly underline?: boolean | null | undefined;
851
- readonly minwidth?: number | null | undefined;
852
- readonly minheight?: number | null | undefined;
853
- readonly maxfontsize?: number | null | undefined;
854
- readonly maxtextwidth?: number | null | undefined;
855
- readonly iswithinpill?: boolean | null | undefined;
856
- readonly hasleadingicon?: boolean | null | undefined;
857
- } | null | undefined;
858
- } | null | undefined;
859
- };
443
+ export declare const deserializeLucidCardFieldDisplaySettings: typeof CardFieldDisplaySettingsFormatter.fromJson;
860
444
  /**
861
445
  * These are the six possible values for the status of a basic card block.
862
446
  */
@@ -100,6 +100,11 @@ var OnClickHandlerKeys;
100
100
  * Display a panel on the canvas when a stencil is clicked, showing a list of items related to the stencil field
101
101
  */
102
102
  OnClickHandlerKeys["ListStencilPanel"] = "ListStencilPanel";
103
+ /**
104
+ * @experimental
105
+ * Open the right-hand card details panel and navigate to a specific target tab
106
+ */
107
+ OnClickHandlerKeys["OpenTargetTab"] = "OpenTargetTab";
103
108
  })(OnClickHandlerKeys || (exports.OnClickHandlerKeys = OnClickHandlerKeys = {}));
104
109
  exports.isOnClickHandlerKey = (0, validators_1.enumValidator)(OnClickHandlerKeys);
105
110
  const TextBadgeSettingsFormatter = (0, objectformat_1.ObjectFormat)({
@@ -180,6 +185,11 @@ const StencilConfigFormatter = (0, objectformat_1.ObjectFormat)({
180
185
  * If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
181
186
  */
182
187
  linkFormula: ['l', (0, format_1.OptionFormat)(primitiveformat_1.StringFormat)],
188
+ /**
189
+ * @experimental
190
+ * If onClickHandlerKey is OpenTargetTab, this specifies the label of the tab to open.
191
+ */
192
+ targetTabLabel: ['targetTabLabel', (0, format_1.OptionFormat)(primitiveformat_1.StringFormat)],
183
193
  /**
184
194
  * Allows the same card to have multiple textbadges but have different properties.
185
195
  * You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
@@ -1,5 +1,5 @@
1
- import { SerializedFieldType } from '../data/serializedfield/serializedfields';
2
- import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
1
+ import type { SerializedFieldType } from '../data/serializedfield/serializedfields';
2
+ import type { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
3
3
  /**
4
4
  * The amount of results that will be displayed per page when using pagination. To enable pagination, define the
5
5
  * {@link SearchResult.itemsPerSearchResult} field in your search results and return workitems equal to this variable's
@@ -14,7 +14,7 @@ export interface CardIntegrationAutoSyncConfig {
14
14
  /**
15
15
  * @deprecated Use AutoSyncConfigPhrasesType instead.
16
16
  */
17
- header: string;
17
+ header?: string | undefined;
18
18
  /**
19
19
  * The phrases to use for the auto sync callout. This is used to display the correct strings in the UI.
20
20
  */
@@ -67,6 +67,7 @@ export interface AutoSyncConfigPhrasesType {
67
67
  removingGrowlMessage?: ((count: number) => string) | undefined;
68
68
  }
69
69
  export declare enum SupportedAutoSyncGeneratorType {
70
- Timeline = "timeline"
70
+ Timeline = "timeline",
71
+ DynamicMatrix = "dynamic matrix"
71
72
  }
72
- export declare const isSupportedAutoSyncGeneratorType: (x: unknown) => x is SupportedAutoSyncGeneratorType.Timeline;
73
+ export declare const isSupportedAutoSyncGeneratorType: (x: unknown) => x is SupportedAutoSyncGeneratorType;
@@ -11,5 +11,6 @@ exports.AutoSyncPaginationSize = 50;
11
11
  var SupportedAutoSyncGeneratorType;
12
12
  (function (SupportedAutoSyncGeneratorType) {
13
13
  SupportedAutoSyncGeneratorType["Timeline"] = "timeline";
14
+ SupportedAutoSyncGeneratorType["DynamicMatrix"] = "dynamic matrix";
14
15
  })(SupportedAutoSyncGeneratorType || (exports.SupportedAutoSyncGeneratorType = SupportedAutoSyncGeneratorType = {}));
15
16
  exports.isSupportedAutoSyncGeneratorType = (0, validators_1.stringEnumValidator)(SupportedAutoSyncGeneratorType);