lucid-extension-sdk 0.0.174 → 0.0.175

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 (63) hide show
  1. package/commandtypes.d.ts +219 -219
  2. package/core/cardintegration/cardfielddisplaysettings.d.ts +2 -2
  3. package/core/cardintegration/cardintegrationconfig.d.ts +1 -1
  4. package/core/cardintegration/cardintegrationdefinitions.d.ts +2 -2
  5. package/core/checks.d.ts +1 -1
  6. package/core/data/fieldspecification.d.ts +4 -4
  7. package/core/data/fieldtypedefinition/basefieldtypedefinition.d.ts +3 -3
  8. package/core/data/fieldtypedefinition/collectionenumfieldtype.d.ts +1 -1
  9. package/core/data/fieldtypedefinition/fieldtypearray.d.ts +3 -3
  10. package/core/data/fieldtypedefinition/fieldtypedefinition.d.ts +2 -2
  11. package/core/data/fieldtypedefinition/literalfieldtype.d.ts +1 -1
  12. package/core/data/fieldtypedefinition/ndimensionalfieldtypearray.d.ts +1 -1
  13. package/core/data/referencekeys/serializedreferencekey.d.ts +4 -4
  14. package/core/data/serializedfield/serializedfielddefinition.d.ts +2 -2
  15. package/core/data/serializedfield/serializedfields.d.ts +15 -15
  16. package/core/data/serializedfield/serializedschema.d.ts +2 -2
  17. package/core/guards.d.ts +3 -3
  18. package/core/jsonserializable.d.ts +2 -2
  19. package/core/offsettype.d.ts +1 -1
  20. package/core/optionalkey.d.ts +4 -4
  21. package/core/properties/datagraphic/badgeposition.d.ts +1 -1
  22. package/core/properties/datagraphic/datagraphicindexes.d.ts +3 -3
  23. package/core/properties/datagraphic/staticdatagraphicsettings.d.ts +2 -2
  24. package/core/properties/fillcolor.d.ts +4 -4
  25. package/core/properties/shadow.d.ts +1 -1
  26. package/core/result.d.ts +1 -1
  27. package/core/rules/conditions.d.ts +1 -1
  28. package/core/rules/serializedcondition.d.ts +3 -3
  29. package/core/rules/serializeddatagraphic.d.ts +2 -2
  30. package/core/rules/serializedeffect.d.ts +3 -3
  31. package/core/rules/serializedstencilgraphic.d.ts +1 -1
  32. package/core/serializeddataerror.d.ts +1 -1
  33. package/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts +1 -1
  34. package/core/validators/validators.d.ts +1 -1
  35. package/core/xhr.d.ts +1 -1
  36. package/data/referencekeydefinition.d.ts +1 -1
  37. package/data/schemadefinition.d.ts +1 -1
  38. package/dataconnector/actions/action.d.ts +3 -3
  39. package/dataconnector/actions/managewebhookresponsebody.d.ts +1 -1
  40. package/dataconnector/actions/patchresponsebody.d.ts +4 -4
  41. package/dataconnector/cryptodependencies.d.ts +1 -1
  42. package/dataconnector/dataconnector.d.ts +3 -3
  43. package/dataconnector/dataconnectorclient.d.ts +1 -1
  44. package/dataconnector/datasourcemetadatatypes.d.ts +1 -1
  45. package/dataconnector/datasourceupdatetypes.d.ts +4 -4
  46. package/dataconnector/debugserver.d.ts +3 -3
  47. package/dataconnector/defaultfetchfunction.d.ts +1 -1
  48. package/document/blockclasses/blockproxyregistry.d.ts +1 -1
  49. package/document/blockclasses/customblockproxy.d.ts +1 -1
  50. package/document/blockclasses/linkunfurlblockproxy.d.ts +1 -1
  51. package/document/documentproxy.js +3 -3
  52. package/document/elementproxy.js +20 -20
  53. package/document/linedefinition.d.ts +1 -1
  54. package/document/linetextareapositioning.d.ts +1 -1
  55. package/document/mapproxy.d.ts +1 -1
  56. package/document/ruledefinition.d.ts +2 -2
  57. package/editorclient.d.ts +2 -2
  58. package/editorclient.js +5 -5
  59. package/math.d.ts +2 -2
  60. package/package.json +1 -1
  61. package/ui/modal.d.ts +1 -1
  62. package/ui/panel.d.ts +1 -1
  63. package/ui/viewport.d.ts +1 -1
package/commandtypes.d.ts CHANGED
@@ -137,7 +137,7 @@ export declare const commandTitles: Map<CommandName, string>;
137
137
  * return types from [EditorClient.sendCommand](#classes_editorclient-EditorClient_sendcommand) based on
138
138
  * which command name you pass in as the first parameter.
139
139
  */
140
- export declare type CommandArgs = {
140
+ export type CommandArgs = {
141
141
  [CommandName.AddCardIntegration]: {
142
142
  query: AddCardIntegrationQuery;
143
143
  result: AddCardIntegrationResult;
@@ -575,7 +575,7 @@ export declare type CommandArgs = {
575
575
  result: ZOrderResult;
576
576
  };
577
577
  };
578
- export declare type AddCardIntegrationQuery = {
578
+ export type AddCardIntegrationQuery = {
579
579
  /** Title/name */
580
580
  'n': string;
581
581
  /** Data connector name */
@@ -620,8 +620,8 @@ export declare type AddCardIntegrationQuery = {
620
620
  'cc': string;
621
621
  } | undefined;
622
622
  };
623
- export declare type AddCardIntegrationResult = undefined;
624
- export declare type AddLineTextAreaQuery = {
623
+ export type AddCardIntegrationResult = undefined;
624
+ export type AddLineTextAreaQuery = {
625
625
  /** Which line */
626
626
  'id': string;
627
627
  /** Where to place the text along the line */
@@ -630,10 +630,10 @@ export declare type AddLineTextAreaQuery = {
630
630
  't': string;
631
631
  };
632
632
  /** The name of the created text area */
633
- export declare type AddLineTextAreaResult = string;
633
+ export type AddLineTextAreaResult = string;
634
634
  /** @ignore */
635
- export declare type UnionToIntersection<T> = (T extends any ? (x: T) => unknown : never) extends (x: infer R) => unknown ? R : never;
636
- export declare type AddMenuItemQuery = {
635
+ export type UnionToIntersection<T> = (T extends any ? (x: T) => unknown : never) extends (x: infer R) => unknown ? R : never;
636
+ export type AddMenuItemQuery = {
637
637
  /** Label to display on the menu item */
638
638
  'l': string;
639
639
  /** Named action to run when the menu item is clicked */
@@ -658,8 +658,8 @@ export declare type AddMenuItemQuery = {
658
658
  'b'?: boolean;
659
659
  } | undefined;
660
660
  };
661
- export declare type AddMenuItemResult = undefined;
662
- export declare type AddShapeDataQuery = {
661
+ export type AddMenuItemResult = undefined;
662
+ export type AddShapeDataQuery = {
663
663
  /** ID of the element to add this shape data to */
664
664
  'id'?: string | undefined;
665
665
  /** Name for this shape data */
@@ -669,9 +669,9 @@ export declare type AddShapeDataQuery = {
669
669
  /** Initial value of this shape data; use a string beginning with '=' for a formula */
670
670
  'v'?: SerializedFieldType;
671
671
  };
672
- export declare type AddShapeDataResult = undefined;
672
+ export type AddShapeDataResult = undefined;
673
673
  /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
674
- export declare type AddSpreadsheetIntegrationQuery = {
674
+ export type AddSpreadsheetIntegrationQuery = {
675
675
  /** labelDescription */
676
676
  'ld': string;
677
677
  /** labelIconUrl */
@@ -688,8 +688,8 @@ export declare type AddSpreadsheetIntegrationQuery = {
688
688
  'ic': string;
689
689
  };
690
690
  /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
691
- export declare type AddSpreadsheetIntegrationResult = undefined;
692
- export declare type AlertQuery = {
691
+ export type AddSpreadsheetIntegrationResult = undefined;
692
+ export type AlertQuery = {
693
693
  /** Title; defaults to extension title */
694
694
  't'?: string | undefined;
695
695
  /** Body text */
@@ -698,16 +698,16 @@ export declare type AlertQuery = {
698
698
  'bt'?: string | undefined;
699
699
  };
700
700
  /** True if they click OK, false otherwise */
701
- export declare type AlertResult = Promise<boolean>;
702
- export declare type AwaitDataSourceImportQuery = {
701
+ export type AlertResult = Promise<boolean>;
702
+ export type AwaitDataSourceImportQuery = {
703
703
  /** Data Connector Name */
704
704
  'n': string;
705
705
  /** Sync data source ID Nonce */
706
706
  's': string;
707
707
  };
708
708
  /** Promise resolving to the data source ID where the data arrived */
709
- export declare type AwaitDataSourceImportResult = Promise<string>;
710
- export declare type AwaitImportQuery = {
709
+ export type AwaitDataSourceImportResult = Promise<string>;
710
+ export type AwaitImportQuery = {
711
711
  /** Data Connector Name */
712
712
  'n': string;
713
713
  /** Sync data source ID Nonce */
@@ -720,8 +720,8 @@ export declare type AwaitImportQuery = {
720
720
  't': number;
721
721
  };
722
722
  /** Promise resolving to the collection ID where the data arrived */
723
- export declare type AwaitImportResult = Promise<string>;
724
- export declare type BootstrapQuery = {
723
+ export type AwaitImportResult = Promise<string>;
724
+ export type BootstrapQuery = {
725
725
  /**
726
726
  * Named action that accepts the bootstrap data, and which may return a Promise or void. After awaiting\
727
727
  * the result of the callback, the bootstrap data is cleared.
@@ -732,21 +732,21 @@ export declare type BootstrapQuery = {
732
732
  */
733
733
  'm'?: boolean | undefined;
734
734
  };
735
- export declare type BootstrapResult = Promise<void>;
735
+ export type BootstrapResult = Promise<void>;
736
736
  export declare enum HashAlgorithmEnum {
737
737
  /** Use the SHA 256 hashing algorithm */
738
738
  sha256 = "SHA256"
739
739
  }
740
- export declare type CalculateHashQuery = {
740
+ export type CalculateHashQuery = {
741
741
  'a': HashAlgorithmEnum;
742
742
  's': string;
743
743
  };
744
- export declare type CalculateHashResult = string;
745
- export declare type CanEditPackageSettingsQuery = undefined;
746
- export declare type CanEditPackageSettingsResult = Promise<boolean>;
747
- export declare type CancelDragBlockToCanvasQuery = void;
748
- export declare type CancelDragBlockToCanvasResult = undefined;
749
- export declare type ConfirmQuery = {
744
+ export type CalculateHashResult = string;
745
+ export type CanEditPackageSettingsQuery = undefined;
746
+ export type CanEditPackageSettingsResult = Promise<boolean>;
747
+ export type CancelDragBlockToCanvasQuery = void;
748
+ export type CancelDragBlockToCanvasResult = undefined;
749
+ export type ConfirmQuery = {
750
750
  /** Title; defaults to extension title */
751
751
  't'?: string | undefined;
752
752
  /** Body text */
@@ -757,8 +757,8 @@ export declare type ConfirmQuery = {
757
757
  'c'?: string | undefined;
758
758
  };
759
759
  /** True if they click OK, false otherwise */
760
- export declare type ConfirmResult = Promise<boolean>;
761
- export declare type CreateBlockQuery = {
760
+ export type ConfirmResult = Promise<boolean>;
761
+ export type CreateBlockQuery = {
762
762
  /**
763
763
  * By default, we add the block to the current page & currently active group. If specified, the
764
764
  * block will instead be created as a direct child of the given page.
@@ -769,14 +769,14 @@ export declare type CreateBlockQuery = {
769
769
  /** If specified, the stencil for a custom shape. Only valid if the class name is 'CustomBlock' */
770
770
  's'?: JsonSerializable | undefined;
771
771
  };
772
- export declare type CreateBlockResult = string;
773
- export declare type CreateCollectionFieldDefinition = {
772
+ export type CreateBlockResult = string;
773
+ export type CreateCollectionFieldDefinition = {
774
774
  /** Name of the field */
775
775
  'n': string;
776
776
  /** Type of the values in this field */
777
777
  't': SerializedFieldTypeDefinition;
778
778
  };
779
- export declare type CreateCollectionQuery = {
779
+ export type CreateCollectionQuery = {
780
780
  /** ID of the data source to add this collection to */
781
781
  's': string;
782
782
  /** Name of the collection */
@@ -787,8 +787,8 @@ export declare type CreateCollectionQuery = {
787
787
  'p': string[];
788
788
  'fl'?: Record<string, string> | undefined;
789
789
  };
790
- export declare type CreateCollectionResult = string;
791
- export declare type CreateDataSourceQuery = {
790
+ export type CreateCollectionResult = string;
791
+ export type CreateDataSourceQuery = {
792
792
  /** Name of the data source */
793
793
  'n': string;
794
794
  /** Source configuration for this data source--information about where it came from, or any metadata that might be useful */
@@ -796,36 +796,36 @@ export declare type CreateDataSourceQuery = {
796
796
  [key: string]: JsonSerializable;
797
797
  };
798
798
  };
799
- export declare type CreateDataSourceResult = string;
800
- export declare type CreateDocumentElementQuery = {
799
+ export type CreateDataSourceResult = string;
800
+ export type CreateDocumentElementQuery = {
801
801
  /** Type of element to create */
802
802
  't': DocumentElementType;
803
803
  /** Properties to set on that element */
804
804
  'p': Record<string, any>;
805
805
  };
806
- export declare type CreateDocumentElementResult = string | undefined;
807
- export declare type CreateLineQuery = {
806
+ export type CreateDocumentElementResult = string | undefined;
807
+ export type CreateLineQuery = {
808
808
  /**
809
809
  * By default, we add the line to the current page & currently active group. If specified, the
810
810
  * line will instead be created as a direct child of the given page.
811
811
  */
812
812
  'p'?: string | undefined;
813
813
  };
814
- export declare type CreateLineResult = string;
815
- export declare type CreatePageQuery = void;
816
- export declare type CreatePageResult = string;
817
- export declare type CreateUserImageQuery = {
814
+ export type CreateLineResult = string;
815
+ export type CreatePageQuery = void;
816
+ export type CreatePageResult = string;
817
+ export type CreateUserImageQuery = {
818
818
  /** media type */
819
819
  't': string;
820
820
  /** base64-encoded image data */
821
821
  'd': string;
822
822
  };
823
- export declare type RawCreateUserImageResult = {
823
+ export type RawCreateUserImageResult = {
824
824
  /** The resulting image URL */
825
825
  'u': string;
826
826
  };
827
- export declare type CreateUserImageResult = Promise<RawCreateUserImageResult>;
828
- export declare type DataActionQuery = {
827
+ export type CreateUserImageResult = Promise<RawCreateUserImageResult>;
828
+ export type DataActionQuery = {
829
829
  /** Flow Name */
830
830
  'fn': string;
831
831
  /** Is Async */
@@ -837,7 +837,7 @@ export declare type DataActionQuery = {
837
837
  /** Data Connector Name */
838
838
  'n': string;
839
839
  };
840
- export declare type RawDataActionResult = {
840
+ export type RawDataActionResult = {
841
841
  /** The external service responded with this code */
842
842
  'c': number;
843
843
  } & ({
@@ -847,28 +847,28 @@ export declare type RawDataActionResult = {
847
847
  /** Or this JSON */
848
848
  'j': unknown;
849
849
  });
850
- export declare type DataActionResult = Promise<RawDataActionResult>;
851
- export declare type DataItemExistsQuery = {
850
+ export type DataActionResult = Promise<RawDataActionResult>;
851
+ export type DataItemExistsQuery = {
852
852
  /** Collection ID to check */
853
853
  'c': string;
854
854
  /** Primary key to check */
855
855
  'pk': string;
856
856
  };
857
- export declare type DataItemExistsResult = boolean;
858
- export declare type DeleteDocumentElementQuery = string;
859
- export declare type DeleteDocumentElementResult = boolean;
860
- export declare type DeleteItemQuery = string;
861
- export declare type DeleteItemResult = boolean;
862
- export declare type DeletePageQuery = string;
863
- export declare type DeletePageResult = boolean;
864
- export declare type DeleteShapeDataQuery = {
857
+ export type DataItemExistsResult = boolean;
858
+ export type DeleteDocumentElementQuery = string;
859
+ export type DeleteDocumentElementResult = boolean;
860
+ export type DeleteItemQuery = string;
861
+ export type DeleteItemResult = boolean;
862
+ export type DeletePageQuery = string;
863
+ export type DeletePageResult = boolean;
864
+ export type DeleteShapeDataQuery = {
865
865
  /** ID of the element to delete this shape data from */
866
866
  'id'?: string | undefined;
867
867
  /** Name for this shape data */
868
868
  'n': string;
869
869
  };
870
- export declare type DeleteShapeDataResult = undefined;
871
- export declare type DownloadQuery = {
870
+ export type DeleteShapeDataResult = undefined;
871
+ export type DownloadQuery = {
872
872
  /** Filename of the download */
873
873
  'f': string;
874
874
  /** Data to put in the file */
@@ -878,50 +878,50 @@ export declare type DownloadQuery = {
878
878
  /** If true, data is base64-encoded and should be converted to binary for download */
879
879
  'b64': boolean;
880
880
  };
881
- export declare type DownloadResult = undefined;
882
- export declare type DragPointerMoveQuery = {
881
+ export type DownloadResult = undefined;
882
+ export type DragPointerMoveQuery = {
883
883
  'x': number;
884
884
  'y': number;
885
885
  };
886
- export declare type DragPointerMoveResult = undefined;
887
- export declare type DragPointerUpQuery = {
886
+ export type DragPointerMoveResult = undefined;
887
+ export type DragPointerUpQuery = {
888
888
  'x': number;
889
889
  'y': number;
890
890
  };
891
- export declare type DragPointerUpResult = undefined;
892
- export declare type ElementExistsQuery = {
891
+ export type DragPointerUpResult = undefined;
892
+ export type ElementExistsQuery = {
893
893
  'id'?: string | undefined;
894
894
  };
895
- export declare type ElementExistsResult = boolean;
896
- export declare type ExecuteFormulaQuery = {
895
+ export type ElementExistsResult = boolean;
896
+ export type ExecuteFormulaQuery = {
897
897
  /** ID of the element to execute a formula on */
898
898
  'id': string;
899
899
  /** Formula to execute, e.g. '@a + @b' or 'CONTAINEDBY' */
900
900
  'f': string;
901
901
  };
902
- export declare type ExecuteFormulaResult = SerializedFieldType | SerializedDataError;
903
- export declare type AnimateViewportQuery = {
902
+ export type ExecuteFormulaResult = SerializedFieldType | SerializedDataError;
903
+ export type AnimateViewportQuery = {
904
904
  /** ID of the page to view */
905
905
  'p': string;
906
906
  /** Bounding box on that page that will fill as much of the viewport as possible */
907
907
  'bb': Box;
908
908
  };
909
- export declare type AnimateViewportResult = Promise<void>;
910
- export declare type GetElementTypeQuery = {
909
+ export type AnimateViewportResult = Promise<void>;
910
+ export type GetElementTypeQuery = {
911
911
  'id'?: string | undefined;
912
912
  };
913
- export declare type GetElementTypeResult = 'block' | 'line' | 'group' | 'visual-activity' | 'page' | 'document' | 'generator' | 'panel';
914
- export declare type GetConnectedLinesQuery = string;
915
- export declare type GetConnectedLinesResult = string[];
916
- export declare type GetCurrentPageQuery = void;
917
- export declare type GetCurrentPageResult = string | undefined;
918
- export declare type GetCustomShapeQuery = {
913
+ export type GetElementTypeResult = 'block' | 'line' | 'group' | 'visual-activity' | 'page' | 'document' | 'generator' | 'panel';
914
+ export type GetConnectedLinesQuery = string;
915
+ export type GetConnectedLinesResult = string[];
916
+ export type GetCurrentPageQuery = void;
917
+ export type GetCurrentPageResult = string | undefined;
918
+ export type GetCustomShapeQuery = {
919
919
  /** Name of the custom shape library in this same extension package */
920
920
  'l': string;
921
921
  /** Name of the shape in that library to find */
922
922
  's': string;
923
923
  };
924
- export declare type GetCustomShapeResult = Promise<{
924
+ export type GetCustomShapeResult = Promise<{
925
925
  /** Value which can be used as the Stencil property on a dynamic shape */
926
926
  's': JsonSerializable;
927
927
  /** Default size (x:0, y:0) of this custom shape */
@@ -929,7 +929,7 @@ export declare type GetCustomShapeResult = Promise<{
929
929
  /** Other default property values */
930
930
  'p': JsonObject;
931
931
  } | undefined>;
932
- export declare type GetDataItemFieldQuery = {
932
+ export type GetDataItemFieldQuery = {
933
933
  /** Collection ID to query */
934
934
  'c': string;
935
935
  /** Primary key of the data item to read */
@@ -937,17 +937,17 @@ export declare type GetDataItemFieldQuery = {
937
937
  /** Name of field to read */
938
938
  'f': string;
939
939
  };
940
- export declare type GetDataItemFieldResult = SerializedFieldType;
941
- export declare type GetDocumentIdQuery = void;
942
- export declare type GetDocumentIdResult = string;
943
- export declare type GetItemPageIdQuery = string;
944
- export declare type GetItemPageIdResult = string;
940
+ export type GetDataItemFieldResult = SerializedFieldType;
941
+ export type GetDocumentIdQuery = void;
942
+ export type GetDocumentIdResult = string;
943
+ export type GetItemPageIdQuery = string;
944
+ export type GetItemPageIdResult = string;
945
945
  export declare enum GetItemsAtSearchType {
946
946
  PossiblyOverlapping = 0,
947
947
  Overlapping = 1,
948
948
  Contained = 2
949
949
  }
950
- export declare type GetItemsAtQuery = {
950
+ export type GetItemsAtQuery = {
951
951
  /** Page ID to search */
952
952
  'p': string;
953
953
  /** Bounding box to search */
@@ -956,155 +956,155 @@ export declare type GetItemsAtQuery = {
956
956
  's': GetItemsAtSearchType;
957
957
  };
958
958
  /** IDs of the items found */
959
- export declare type GetItemsAtResult = string[];
960
- export declare type GetReferenceKeyQuery = {
959
+ export type GetItemsAtResult = string[];
960
+ export type GetReferenceKeyQuery = {
961
961
  /** ID of the LucidElement to read a reference key from, or undefined to read from the LucidDocument */
962
962
  'id'?: string | undefined;
963
963
  /** Reference key to get */
964
964
  'k': number | string;
965
965
  };
966
- export declare type GetReferenceKeyResult = SerializedReferenceKeyType;
967
- export declare type GetProductQuery = undefined;
968
- export declare type GetProductResult = LucidProduct;
969
- export declare type GetPropertyQuery = {
966
+ export type GetReferenceKeyResult = SerializedReferenceKeyType;
967
+ export type GetProductQuery = undefined;
968
+ export type GetProductResult = LucidProduct;
969
+ export type GetPropertyQuery = {
970
970
  /** ID of the LucidElement to read a property from, or undefined to read from the LucidDocument */
971
971
  'id'?: string | undefined;
972
972
  /** Name of the property to read */
973
973
  'p': string;
974
974
  };
975
- export declare type GetPropertyResult = JsonSerializable;
976
- export declare type GetPackageSettingsQuery = undefined;
977
- export declare type GetPackageSettingsResult = Promise<Record<string, JsonSerializable>>;
978
- export declare type GetRelativeLinePositionQuery = {
975
+ export type GetPropertyResult = JsonSerializable;
976
+ export type GetPackageSettingsQuery = undefined;
977
+ export type GetPackageSettingsResult = Promise<Record<string, JsonSerializable>>;
978
+ export type GetRelativeLinePositionQuery = {
979
979
  /** Block or line ID to check the connections on */
980
980
  'id': string;
981
981
  /** Relative position in range of [0,1] along the line */
982
982
  'p': number;
983
983
  };
984
- export declare type GetRelativeLinePositionResult = Point;
985
- export declare type GetSelectionQuery = {
984
+ export type GetRelativeLinePositionResult = Point;
985
+ export type GetSelectionQuery = {
986
986
  /** If set, additionally return all items inside selected groups */
987
987
  'd'?: boolean | undefined;
988
988
  };
989
- export declare type GetSelectionResult = string[];
990
- export declare type GetShapeDataQuery = {
989
+ export type GetSelectionResult = string[];
990
+ export type GetShapeDataQuery = {
991
991
  /** ID of the element to query shape data from */
992
992
  'id'?: string | undefined;
993
993
  /** Name of the shape data to read */
994
994
  'n': string;
995
995
  };
996
- export declare type GetShapeDataResult = SerializedFieldType | SerializedDataError;
997
- export declare type GetTextStyleQuery = {
996
+ export type GetShapeDataResult = SerializedFieldType | SerializedDataError;
997
+ export type GetTextStyleQuery = {
998
998
  /** ID of the element to get text style from */
999
999
  'id': string;
1000
1000
  /** Name of the text area to get text style from */
1001
1001
  'n': string;
1002
1002
  };
1003
- export declare type GetTextStyleResult = TextStyle;
1004
- export declare type GetUserIdQuery = void;
1005
- export declare type GetUserIdResult = string;
1006
- export declare type GetVisibleRectQuery = void;
1007
- export declare type GetVisibleRectResult = Box;
1008
- export declare type HideModalQuery = {
1003
+ export type GetTextStyleResult = TextStyle;
1004
+ export type GetUserIdQuery = void;
1005
+ export type GetUserIdResult = string;
1006
+ export type GetVisibleRectQuery = void;
1007
+ export type GetVisibleRectResult = Box;
1008
+ export type HideModalQuery = {
1009
1009
  /** Name of the modal's action for receiving events, i.e. ShowModalQuery['n'] */
1010
1010
  'n': string;
1011
1011
  };
1012
- export declare type HideModalResult = undefined;
1013
- export declare type HidePanelQuery = {
1012
+ export type HideModalResult = undefined;
1013
+ export type HidePanelQuery = {
1014
1014
  /** Name of the panel's action for receiving events, i.e. RegisterPanelQuery['n'] */
1015
1015
  'n': string;
1016
1016
  };
1017
- export declare type HidePanelResult = undefined;
1018
- export declare type HookAllChangesQuery = {
1017
+ export type HidePanelResult = undefined;
1018
+ export type HookAllChangesQuery = {
1019
1019
  /** Name of the action for receiving events. Will be called with no parameters periodically as changes are made to the document */
1020
1020
  'n': string;
1021
1021
  };
1022
- export declare type HookAllChangesResult = undefined;
1023
- export declare type HookCreateItemsQuery = {
1022
+ export type HookAllChangesResult = undefined;
1023
+ export type HookCreateItemsQuery = {
1024
1024
  /** Name of the action for receiving events. Will be called with an array of strings of all recently created item IDs. */
1025
1025
  'n': string;
1026
1026
  };
1027
- export declare type HookCreateItemsResult = undefined;
1028
- export declare type HookDeleteItemsQuery = {
1027
+ export type HookCreateItemsResult = undefined;
1028
+ export type HookDeleteItemsQuery = {
1029
1029
  /** Name of the action for receiving events. Will be called with an array of strings of all recently deleted item IDs. */
1030
1030
  'n': string;
1031
1031
  };
1032
- export declare type HookDeleteItemsResult = undefined;
1033
- export declare type HookSelectionQuery = {
1032
+ export type HookDeleteItemsResult = undefined;
1033
+ export type HookSelectionQuery = {
1034
1034
  /** Name of the action for receiving events. Will be called with an array of strings of all selected item IDs. */
1035
1035
  'n': string;
1036
1036
  };
1037
- export declare type HookSelectionResult = undefined;
1038
- export declare type HookTextEditQuery = {
1037
+ export type HookSelectionResult = undefined;
1038
+ export type HookTextEditQuery = {
1039
1039
  /** Name of the action for receiving these events */
1040
1040
  'n': string;
1041
1041
  };
1042
- export declare type HookTextEditResult = undefined;
1042
+ export type HookTextEditResult = undefined;
1043
1043
  /** Name of the card integration registered by this extension to show the import dialog for */
1044
- export declare type ImportCardsQuery = string;
1044
+ export type ImportCardsQuery = string;
1045
1045
  /** Resolves when the import dialog is closed */
1046
- export declare type ImportCardsResult = Promise<void>;
1047
- export declare type ImportPageQuery = {
1046
+ export type ImportCardsResult = Promise<void>;
1047
+ export type ImportPageQuery = {
1048
1048
  /** The ID of the document or template to import */
1049
1049
  'id': string;
1050
1050
  /** Page numbers of specified document or template to import (zero-indexed) */
1051
1051
  'n': number[];
1052
1052
  };
1053
1053
  /** Resolves when the import succeeds or fails */
1054
- export declare type ImportPageResult = Promise<void>;
1055
- export declare type KillExtensionQuery = void;
1056
- export declare type KillExtensionResult = undefined;
1057
- export declare type ListChildrenQuery = {
1054
+ export type ImportPageResult = Promise<void>;
1055
+ export type KillExtensionQuery = void;
1056
+ export type KillExtensionResult = undefined;
1057
+ export type ListChildrenQuery = {
1058
1058
  /** Parent ID to search inside */
1059
1059
  'id': string;
1060
1060
  /** "deep" - If true, get all children at any level of group nesting; otherwise only immediate children */
1061
1061
  'd'?: boolean;
1062
1062
  };
1063
- export declare type ListChildrenResult = string[];
1064
- export declare type ListCollectionsQuery = {
1063
+ export type ListChildrenResult = string[];
1064
+ export type ListCollectionsQuery = {
1065
1065
  /** ID of the data source to list collections for */
1066
1066
  'id': string;
1067
1067
  };
1068
- export declare type ListCollectionsResult = string[];
1069
- export declare type ListDataItemsQuery = {
1068
+ export type ListCollectionsResult = string[];
1069
+ export type ListDataItemsQuery = {
1070
1070
  /** Collection ID to list items from */
1071
1071
  'id': string;
1072
1072
  };
1073
- export declare type ListDataItemsResult = string[];
1074
- export declare type ListCollectionFieldsQuery = {
1073
+ export type ListDataItemsResult = string[];
1074
+ export type ListCollectionFieldsQuery = {
1075
1075
  /** Collection ID to query */
1076
1076
  'id': string;
1077
1077
  };
1078
- export declare type ListCollectionFieldsResult = string[];
1079
- export declare type ListDataSourcesQuery = undefined;
1080
- export declare type ListDataSourcesResult = string[];
1081
- export declare type ListDocumentElementsQuery = {
1078
+ export type ListCollectionFieldsResult = string[];
1079
+ export type ListDataSourcesQuery = undefined;
1080
+ export type ListDataSourcesResult = string[];
1081
+ export type ListDocumentElementsQuery = {
1082
1082
  't': DocumentElementType;
1083
1083
  };
1084
- export declare type ListDocumentElementsResult = string[];
1085
- export declare type ListPagesQuery = void;
1086
- export declare type ListPagesResult = string[];
1087
- export declare type ListReferenceKeysQuery = {
1084
+ export type ListDocumentElementsResult = string[];
1085
+ export type ListPagesQuery = void;
1086
+ export type ListPagesResult = string[];
1087
+ export type ListReferenceKeysQuery = {
1088
1088
  /** ID of the element to list reference keys for, or undefined for the document */
1089
1089
  'id'?: string | undefined;
1090
1090
  };
1091
1091
  /** Reference key IDs */
1092
- export declare type ListReferenceKeysResult = (string | number)[];
1093
- export declare type ListPropertiesQuery = {
1092
+ export type ListReferenceKeysResult = (string | number)[];
1093
+ export type ListPropertiesQuery = {
1094
1094
  'id'?: string | undefined;
1095
1095
  };
1096
- export declare type ListPropertiesResult = string[];
1097
- export declare type ListShapeDataQuery = {
1096
+ export type ListPropertiesResult = string[];
1097
+ export type ListShapeDataQuery = {
1098
1098
  'id'?: string | undefined;
1099
1099
  /** True to include inherited shape data from containing groups and/or page */
1100
1100
  'i'?: boolean | undefined;
1101
1101
  };
1102
- export declare type ListShapeDataResult = string[];
1103
- export declare type ListTextAreasQuery = string;
1104
- export declare type ListTextAreasResult = string[];
1105
- export declare type LoadBlockClassesQuery = string[];
1106
- export declare type LoadBlockClassesResult = Promise<undefined>;
1107
- export declare type OffsetItemsQuery = {
1102
+ export type ListShapeDataResult = string[];
1103
+ export type ListTextAreasQuery = string;
1104
+ export type ListTextAreasResult = string[];
1105
+ export type LoadBlockClassesQuery = string[];
1106
+ export type LoadBlockClassesResult = Promise<undefined>;
1107
+ export type OffsetItemsQuery = {
1108
1108
  /** IDs of the items (blocks, lines, groups) to move */
1109
1109
  'ids': string[];
1110
1110
  /** What kind of offset to perform */
@@ -1112,8 +1112,8 @@ export declare type OffsetItemsQuery = {
1112
1112
  /** How far to offset */
1113
1113
  'o': Point;
1114
1114
  };
1115
- export declare type OffsetItemsResult = undefined;
1116
- export declare type PatchDataItemsQuery = {
1115
+ export type OffsetItemsResult = undefined;
1116
+ export type PatchDataItemsQuery = {
1117
1117
  /** ID of the data collection to patch */
1118
1118
  'id': string;
1119
1119
  /** Data items to add to the collection */
@@ -1124,15 +1124,15 @@ export declare type PatchDataItemsQuery = {
1124
1124
  'd': string[];
1125
1125
  };
1126
1126
  /** Primary keys inserted, if any */
1127
- export declare type PatchDataItemsResult = string[];
1128
- export declare type PromptQuery = {
1127
+ export type PatchDataItemsResult = string[];
1128
+ export type PromptQuery = {
1129
1129
  /** Title; defaults to extension title */
1130
1130
  't'?: string | undefined;
1131
1131
  /** Body text */
1132
1132
  'b': string;
1133
1133
  };
1134
- export declare type PromptResult = Promise<string | undefined>;
1135
- export declare type RegisterLinkImporterQuery = {
1134
+ export type PromptResult = Promise<string | undefined>;
1135
+ export type RegisterLinkImporterQuery = {
1136
1136
  /** ID of the link importer*/
1137
1137
  'id': string;
1138
1138
  /** Action to call to get links for bulk import */
@@ -1142,8 +1142,8 @@ export declare type RegisterLinkImporterQuery = {
1142
1142
  /** Icon URL of the menu item, preferably a base64-encoded URL */
1143
1143
  'i': string;
1144
1144
  };
1145
- export declare type RegisterLinkImporterResult = void;
1146
- export declare type RegisterPanelQuery = {
1145
+ export type RegisterLinkImporterResult = void;
1146
+ export type RegisterPanelQuery = {
1147
1147
  /** Name of the panel's action for receiving events; generated automatically by Panel base class */
1148
1148
  'n': string;
1149
1149
  /** Title to show on the panel */
@@ -1163,41 +1163,41 @@ export declare type RegisterPanelQuery = {
1163
1163
  /** If true, we will persist the panel's iframe */
1164
1164
  'p'?: boolean;
1165
1165
  };
1166
- export declare type RegisterPanelResult = undefined;
1167
- export declare type RegisterUnfurlQuery = {
1166
+ export type RegisterPanelResult = undefined;
1167
+ export type RegisterUnfurlQuery = {
1168
1168
  /** Domain to unfurl, e.g. www.google.com */
1169
1169
  'd': string;
1170
1170
  /** Action to call to configure the unfurl */
1171
1171
  'a': string;
1172
1172
  };
1173
- export declare type RegisterUnfurlResult = boolean;
1174
- export declare type ReloadExtensionQuery = void;
1175
- export declare type ReloadExtensionResult = undefined;
1176
- export declare type SendOAuthRequestQuery = SendXHRQuery & {
1173
+ export type RegisterUnfurlResult = boolean;
1174
+ export type ReloadExtensionQuery = void;
1175
+ export type ReloadExtensionResult = undefined;
1176
+ export type SendOAuthRequestQuery = SendXHRQuery & {
1177
1177
  /** OAuth provider name as specified in the package manifest */
1178
1178
  'p': string;
1179
1179
  /** Post Result To */
1180
1180
  'prt'?: string | undefined;
1181
1181
  };
1182
- export declare type SendAsyncOAuthRequestQuery = SendXHRQuery & {
1182
+ export type SendAsyncOAuthRequestQuery = SendXHRQuery & {
1183
1183
  /** OAuth provider name as specified in the package manifest */
1184
1184
  'p': string;
1185
1185
  };
1186
- export declare type SendPermanentTokenRequestQuery = SendXHRQuery & {
1186
+ export type SendPermanentTokenRequestQuery = SendXHRQuery & {
1187
1187
  /** Permanent token provider name as specified in the package manifest */
1188
1188
  'p': string;
1189
1189
  };
1190
- export declare type SendOAuthRequestResponse = SendXHRResponse;
1191
- export declare type SendPermanentTokenRequestResponse = SendXHRResponse;
1192
- export declare type SendUIMessageQuery = {
1190
+ export type SendOAuthRequestResponse = SendXHRResponse;
1191
+ export type SendPermanentTokenRequestResponse = SendXHRResponse;
1192
+ export type SendUIMessageQuery = {
1193
1193
  /** Name of the UI component's action for receiving events, e.g. ShowModalQuery['n'] */
1194
1194
  'n': string;
1195
1195
  /** Content of the message to send to the custom UI component */
1196
1196
  'd'?: JsonSerializable;
1197
1197
  };
1198
- export declare type SendUIMessageResult = undefined;
1199
- export declare type SendXHRResponseFormat = 'utf8' | 'binary';
1200
- export declare type SendXHRQuery = {
1198
+ export type SendUIMessageResult = undefined;
1199
+ export type SendXHRResponseFormat = 'utf8' | 'binary';
1200
+ export type SendXHRQuery = {
1201
1201
  'url': string;
1202
1202
  /** HTTP method, e.g. 'GET', 'FETCH', etc. Defaults to GET */
1203
1203
  'm'?: string | undefined;
@@ -1224,7 +1224,7 @@ export declare type SendXHRQuery = {
1224
1224
  */
1225
1225
  'f'?: SendXHRResponseFormat | undefined;
1226
1226
  };
1227
- export declare type RawSendXHRResponse = {
1227
+ export type RawSendXHRResponse = {
1228
1228
  /** URL of the response after any redirects */
1229
1229
  'url': string;
1230
1230
  /** Plain-text or base64-encoded response body */
@@ -1238,11 +1238,11 @@ export declare type RawSendXHRResponse = {
1238
1238
  /** true if the request timed out */
1239
1239
  'to'?: boolean;
1240
1240
  };
1241
- export declare type SendXHRResponse = Promise<RawSendXHRResponse>;
1241
+ export type SendXHRResponse = Promise<RawSendXHRResponse>;
1242
1242
  export declare function isRawSendXHRResponse(val: any): val is RawSendXHRResponse;
1243
- export declare type SetCurrentPageQuery = string;
1244
- export declare type SetCurrentPageResult = Promise<void>;
1245
- export declare type SetPropertyQuery = {
1243
+ export type SetCurrentPageQuery = string;
1244
+ export type SetCurrentPageResult = Promise<void>;
1245
+ export type SetPropertyQuery = {
1246
1246
  /** ID of the element to change */
1247
1247
  'id'?: string | undefined;
1248
1248
  /** Name of the property to change */
@@ -1250,8 +1250,8 @@ export declare type SetPropertyQuery = {
1250
1250
  /** New value of the property */
1251
1251
  'v'?: JsonSerializable;
1252
1252
  };
1253
- export declare type SetPropertyResult = undefined;
1254
- export declare type SetReferenceKeyQuery = {
1253
+ export type SetPropertyResult = undefined;
1254
+ export type SetReferenceKeyQuery = {
1255
1255
  /** ID of the element to set the reference key on */
1256
1256
  'id'?: string | undefined;
1257
1257
  /** ID of the reference key to set */
@@ -1259,8 +1259,8 @@ export declare type SetReferenceKeyQuery = {
1259
1259
  /** New reference key settings, or undefined to remove the reference key */
1260
1260
  'v'?: SerializedReferenceKeyType | undefined;
1261
1261
  };
1262
- export declare type SetReferenceKeyResult = undefined;
1263
- export declare type SetShapeDataQuery = {
1262
+ export type SetReferenceKeyResult = undefined;
1263
+ export type SetShapeDataQuery = {
1264
1264
  /** ID of the element to set this shape data on */
1265
1265
  'id'?: string | undefined;
1266
1266
  /** Name for the already-existing shape data to update */
@@ -1268,8 +1268,8 @@ export declare type SetShapeDataQuery = {
1268
1268
  /** Value to set; use a string beginning with '=' for a formula */
1269
1269
  'v'?: SerializedFieldType;
1270
1270
  };
1271
- export declare type SetShapeDataResult = undefined;
1272
- export declare type SetTextQuery = {
1271
+ export type SetShapeDataResult = undefined;
1272
+ export type SetTextQuery = {
1273
1273
  /** ID of the element to change text on */
1274
1274
  'id': string;
1275
1275
  /** Name of the text area to update */
@@ -1279,8 +1279,8 @@ export declare type SetTextQuery = {
1279
1279
  /** Optional force boolean for extension to update uneditable items*/
1280
1280
  'f'?: boolean | undefined;
1281
1281
  };
1282
- export declare type SetTextResult = undefined;
1283
- export declare type SetTextStyleQuery = {
1282
+ export type SetTextResult = undefined;
1283
+ export type SetTextStyleQuery = {
1284
1284
  /** ID of the element to set text style on */
1285
1285
  'id': string;
1286
1286
  /** Name of the text area to set text style on */
@@ -1288,8 +1288,8 @@ export declare type SetTextStyleQuery = {
1288
1288
  /** Text styles to set */
1289
1289
  's': Partial<TextStyle>;
1290
1290
  };
1291
- export declare type SetTextStyleResult = Promise<undefined>;
1292
- export declare type ShowModalQuery = {
1291
+ export type SetTextStyleResult = Promise<undefined>;
1292
+ export type ShowModalQuery = {
1293
1293
  /** Name of the modal's action for receiving events; generated automatically by Modal base class */
1294
1294
  'n': string;
1295
1295
  /** Title to show on the modal */
@@ -1309,17 +1309,17 @@ export declare type ShowModalQuery = {
1309
1309
  /** URL to display in the modal (this or c is required). Can be relative to /public directory in the package */
1310
1310
  'u'?: string | undefined;
1311
1311
  };
1312
- export declare type ShowModalResult = undefined;
1313
- export declare type ShowPackageSettingsModalQuery = undefined;
1314
- export declare type ShowPackageSettingsModalResult = Promise<void>;
1315
- export declare type ShowPanelQuery = {
1312
+ export type ShowModalResult = undefined;
1313
+ export type ShowPackageSettingsModalQuery = undefined;
1314
+ export type ShowPackageSettingsModalResult = Promise<void>;
1315
+ export type ShowPanelQuery = {
1316
1316
  /** Name of the panel's action for receiving events, i.e. RegisterPanelQuery['n'] */
1317
1317
  'n': string;
1318
1318
  };
1319
- export declare type ShowPanelResult = undefined;
1320
- export declare type SleepForTestCaseQuery = number;
1321
- export declare type SleepForTestCaseResult = Promise<void>;
1322
- export declare type StartDragBlockToCanvasQuery = {
1319
+ export type ShowPanelResult = undefined;
1320
+ export type SleepForTestCaseQuery = number;
1321
+ export type SleepForTestCaseResult = Promise<void>;
1322
+ export type StartDragBlockToCanvasQuery = {
1323
1323
  /** Class name of the block to create */
1324
1324
  'c': string;
1325
1325
  /** Size of the block to create */
@@ -1334,72 +1334,72 @@ export declare type StartDragBlockToCanvasQuery = {
1334
1334
  /** If specified, the stencil for a custom shape. Only valid if the class name is 'CustomBlock' */
1335
1335
  's'?: JsonSerializable | undefined;
1336
1336
  };
1337
- export declare type StartDragBlockToCanvasResult = Promise<string | undefined>;
1338
- export declare type StartPDFUploadRequestQuery = string;
1337
+ export type StartDragBlockToCanvasResult = Promise<string | undefined>;
1338
+ export type StartPDFUploadRequestQuery = string;
1339
1339
  /**
1340
1340
  * @ignore
1341
1341
  * A signed URL you can upload the pdf to. You can do this manually (via the client, your own service) or via the
1342
1342
  * oauth proxy.
1343
1343
  */
1344
- export declare type StartPDFUploadRequestResponse = Promise<string>;
1345
- export declare type ThrowForTestCaseQuery = number;
1346
- export declare type ThrowForTestCaseResult = undefined | Promise<void>;
1347
- export declare type TriggerAuthFlowQuery = {
1344
+ export type StartPDFUploadRequestResponse = Promise<string>;
1345
+ export type ThrowForTestCaseQuery = number;
1346
+ export type ThrowForTestCaseResult = undefined | Promise<void>;
1347
+ export type TriggerAuthFlowQuery = {
1348
1348
  /** OAuth or merge provider name as specified in the package manifest */
1349
1349
  'p': string;
1350
1350
  };
1351
- export declare type TriggerAuthFlowResult = Promise<RawTriggerAuthFlowResult>;
1352
- export declare type RawTriggerAuthFlowResult = {
1351
+ export type TriggerAuthFlowResult = Promise<RawTriggerAuthFlowResult>;
1352
+ export type RawTriggerAuthFlowResult = {
1353
1353
  's': boolean;
1354
1354
  };
1355
- export declare type UnhookAllChangesQuery = {
1355
+ export type UnhookAllChangesQuery = {
1356
1356
  /** Name of the action passed to HookAllChanges */
1357
1357
  'n': string;
1358
1358
  };
1359
- export declare type UnhookAllChangesResult = undefined;
1360
- export declare type UnhookCreateItemsQuery = {
1359
+ export type UnhookAllChangesResult = undefined;
1360
+ export type UnhookCreateItemsQuery = {
1361
1361
  /** Name of the action passed to HookCreateItems */
1362
1362
  'n': string;
1363
1363
  };
1364
- export declare type UnhookCreateItemsResult = undefined;
1365
- export declare type UnhookDeleteItemsQuery = {
1364
+ export type UnhookCreateItemsResult = undefined;
1365
+ export type UnhookDeleteItemsQuery = {
1366
1366
  /** Name of the action passed to HookDeleteItems */
1367
1367
  'n': string;
1368
1368
  };
1369
- export declare type UnhookDeleteItemsResult = undefined;
1370
- export declare type UnhookSelectionQuery = {
1369
+ export type UnhookDeleteItemsResult = undefined;
1370
+ export type UnhookSelectionQuery = {
1371
1371
  /** Name of the action for receiving these events */
1372
1372
  'n': string;
1373
1373
  };
1374
- export declare type UnhookSelectionResult = undefined;
1375
- export declare type UnhookTextEditQuery = {
1374
+ export type UnhookSelectionResult = undefined;
1375
+ export type UnhookTextEditQuery = {
1376
1376
  /** Name of the action for receiving these events */
1377
1377
  'n': string;
1378
1378
  };
1379
- export declare type UnhookTextEditResult = undefined;
1380
- export declare type WithMutexQuery = {
1379
+ export type UnhookTextEditResult = undefined;
1380
+ export type WithMutexQuery = {
1381
1381
  /** Name of the intra-document mutex to hold for the duration of this action */
1382
1382
  'n': string;
1383
1383
  /** Name of the action to run within the given mutex */
1384
1384
  'a': string;
1385
1385
  };
1386
1386
  /** Resolves true if operation succeeded, or false if the mutex was held by someone else */
1387
- export declare type WithMutexResult = Promise<boolean>;
1388
- export declare type WithSilentActionsQuery = {
1387
+ export type WithMutexResult = Promise<boolean>;
1388
+ export type WithSilentActionsQuery = {
1389
1389
  /** Name of the synchronous action to run with undo/redo history suppressed */
1390
1390
  'a': string;
1391
1391
  };
1392
- export declare type WithSilentActionsResult = void;
1392
+ export type WithSilentActionsResult = void;
1393
1393
  export declare enum ZOrderOperation {
1394
1394
  UP = 1,
1395
1395
  TOP = 2,
1396
1396
  DOWN = 3,
1397
1397
  BOTTOM = 4
1398
1398
  }
1399
- export declare type ZOrderQuery = {
1399
+ export type ZOrderQuery = {
1400
1400
  /** IDs of the items to adjust Z order */
1401
1401
  'i': string[];
1402
1402
  /** Operation to perform on these items */
1403
1403
  'o': ZOrderOperation;
1404
1404
  };
1405
- export declare type ZOrderResult = undefined;
1405
+ export type ZOrderResult = undefined;