@firestartr/cli 2.6.0-snapshot-2 → 2.6.0-snapshot-4

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.
@@ -522,6 +522,387 @@ export declare enum FirestartrGithubMembershipSpecContextProviderRefKind {
522
522
  /** FirestartrProviderConfig */
523
523
  FIRESTARTR_PROVIDER_CONFIG = "FirestartrProviderConfig"
524
524
  }
525
+ /**
526
+ * A resource to handle GitHub Organization Settings.
527
+ *
528
+ * @schema FirestartrGithubOrganizationSettings
529
+ */
530
+ export declare class FirestartrGithubOrganizationSettings extends ApiObject {
531
+ /**
532
+ * Returns the apiVersion and kind for "FirestartrGithubOrganizationSettings"
533
+ */
534
+ static readonly GVK: GroupVersionKind;
535
+ /**
536
+ * Renders a Kubernetes manifest for "FirestartrGithubOrganizationSettings".
537
+ *
538
+ * This can be used to inline resource manifests inside other objects (e.g. as templates).
539
+ *
540
+ * @param props initialization props
541
+ */
542
+ static manifest(props: FirestartrGithubOrganizationSettingsProps): any;
543
+ /**
544
+ * Defines a "FirestartrGithubOrganizationSettings" API object
545
+ * @param scope the scope in which to define this object
546
+ * @param id a scope-local name for the object
547
+ * @param props initialization props
548
+ */
549
+ constructor(scope: Construct, id: string, props: FirestartrGithubOrganizationSettingsProps);
550
+ /**
551
+ * Renders the object to Kubernetes JSON.
552
+ */
553
+ toJson(): any;
554
+ }
555
+ /**
556
+ * A resource to handle GitHub Organization Settings.
557
+ *
558
+ * @schema FirestartrGithubOrganizationSettings
559
+ */
560
+ export interface FirestartrGithubOrganizationSettingsProps {
561
+ /**
562
+ * @schema FirestartrGithubOrganizationSettings#metadata
563
+ */
564
+ readonly metadata: ApiObjectMetadata;
565
+ /**
566
+ * @schema FirestartrGithubOrganizationSettings#spec
567
+ */
568
+ readonly spec: FirestartrGithubOrganizationSettingsSpec;
569
+ }
570
+ /**
571
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsProps' to JSON representation.
572
+ */
573
+ export declare function toJson_FirestartrGithubOrganizationSettingsProps(obj: FirestartrGithubOrganizationSettingsProps | undefined): Record<string, any> | undefined;
574
+ /**
575
+ * @schema FirestartrGithubOrganizationSettingsSpec
576
+ */
577
+ export interface FirestartrGithubOrganizationSettingsSpec {
578
+ /**
579
+ * GitHub organization targeted by this resource
580
+ *
581
+ * @schema FirestartrGithubOrganizationSettingsSpec#org
582
+ */
583
+ readonly org: string;
584
+ /**
585
+ * Billing email for the GitHub organization
586
+ *
587
+ * @schema FirestartrGithubOrganizationSettingsSpec#billingEmail
588
+ */
589
+ readonly billingEmail: string;
590
+ /**
591
+ * Company name for the GitHub organization
592
+ *
593
+ * @schema FirestartrGithubOrganizationSettingsSpec#company
594
+ */
595
+ readonly company?: string;
596
+ /**
597
+ * Blog URL for the GitHub organization
598
+ *
599
+ * @schema FirestartrGithubOrganizationSettingsSpec#blog
600
+ */
601
+ readonly blog?: string;
602
+ /**
603
+ * Public email for the GitHub organization
604
+ *
605
+ * @schema FirestartrGithubOrganizationSettingsSpec#email
606
+ */
607
+ readonly email?: string;
608
+ /**
609
+ * Twitter username for the GitHub organization
610
+ *
611
+ * @schema FirestartrGithubOrganizationSettingsSpec#twitterUsername
612
+ */
613
+ readonly twitterUsername?: string;
614
+ /**
615
+ * Location of the GitHub organization
616
+ *
617
+ * @schema FirestartrGithubOrganizationSettingsSpec#location
618
+ */
619
+ readonly location?: string;
620
+ /**
621
+ * Display name of the GitHub organization
622
+ *
623
+ * @schema FirestartrGithubOrganizationSettingsSpec#name
624
+ */
625
+ readonly name?: string;
626
+ /**
627
+ * Description of the GitHub organization
628
+ *
629
+ * @schema FirestartrGithubOrganizationSettingsSpec#description
630
+ */
631
+ readonly description?: string;
632
+ /**
633
+ * Whether organization projects are enabled
634
+ *
635
+ * @schema FirestartrGithubOrganizationSettingsSpec#hasOrganizationProjects
636
+ */
637
+ readonly hasOrganizationProjects?: boolean;
638
+ /**
639
+ * Whether repository projects are enabled
640
+ *
641
+ * @schema FirestartrGithubOrganizationSettingsSpec#hasRepositoryProjects
642
+ */
643
+ readonly hasRepositoryProjects?: boolean;
644
+ /**
645
+ * Default repository permission for organization members
646
+ *
647
+ * @schema FirestartrGithubOrganizationSettingsSpec#defaultRepositoryPermission
648
+ */
649
+ readonly defaultRepositoryPermission?: FirestartrGithubOrganizationSettingsSpecDefaultRepositoryPermission;
650
+ /**
651
+ * Whether members can create repositories
652
+ *
653
+ * @schema FirestartrGithubOrganizationSettingsSpec#membersCanCreateRepositories
654
+ */
655
+ readonly membersCanCreateRepositories?: boolean;
656
+ /**
657
+ * Whether members can create public repositories
658
+ *
659
+ * @schema FirestartrGithubOrganizationSettingsSpec#membersCanCreatePublicRepositories
660
+ */
661
+ readonly membersCanCreatePublicRepositories?: boolean;
662
+ /**
663
+ * Whether members can create private repositories
664
+ *
665
+ * @schema FirestartrGithubOrganizationSettingsSpec#membersCanCreatePrivateRepositories
666
+ */
667
+ readonly membersCanCreatePrivateRepositories?: boolean;
668
+ /**
669
+ * Whether members can create internal repositories
670
+ *
671
+ * @schema FirestartrGithubOrganizationSettingsSpec#membersCanCreateInternalRepositories
672
+ */
673
+ readonly membersCanCreateInternalRepositories?: boolean;
674
+ /**
675
+ * Whether members can create GitHub Pages
676
+ *
677
+ * @schema FirestartrGithubOrganizationSettingsSpec#membersCanCreatePages
678
+ */
679
+ readonly membersCanCreatePages?: boolean;
680
+ /**
681
+ * Whether members can create public GitHub Pages
682
+ *
683
+ * @schema FirestartrGithubOrganizationSettingsSpec#membersCanCreatePublicPages
684
+ */
685
+ readonly membersCanCreatePublicPages?: boolean;
686
+ /**
687
+ * Whether members can create private GitHub Pages
688
+ *
689
+ * @schema FirestartrGithubOrganizationSettingsSpec#membersCanCreatePrivatePages
690
+ */
691
+ readonly membersCanCreatePrivatePages?: boolean;
692
+ /**
693
+ * Whether members can fork private repositories
694
+ *
695
+ * @schema FirestartrGithubOrganizationSettingsSpec#membersCanForkPrivateRepositories
696
+ */
697
+ readonly membersCanForkPrivateRepositories?: boolean;
698
+ /**
699
+ * Whether web commit signoff is required
700
+ *
701
+ * @schema FirestartrGithubOrganizationSettingsSpec#webCommitSignoffRequired
702
+ */
703
+ readonly webCommitSignoffRequired?: boolean;
704
+ /**
705
+ * Whether advanced security is enabled for new repositories
706
+ *
707
+ * @schema FirestartrGithubOrganizationSettingsSpec#advancedSecurityEnabledForNewRepositories
708
+ */
709
+ readonly advancedSecurityEnabledForNewRepositories?: boolean;
710
+ /**
711
+ * Whether Dependabot alerts are enabled for new repositories
712
+ *
713
+ * @schema FirestartrGithubOrganizationSettingsSpec#dependabotAlertsEnabledForNewRepositories
714
+ */
715
+ readonly dependabotAlertsEnabledForNewRepositories?: boolean;
716
+ /**
717
+ * Whether Dependabot security updates are enabled for new repositories
718
+ *
719
+ * @schema FirestartrGithubOrganizationSettingsSpec#dependabotSecurityUpdatesEnabledForNewRepositories
720
+ */
721
+ readonly dependabotSecurityUpdatesEnabledForNewRepositories?: boolean;
722
+ /**
723
+ * Whether dependency graph is enabled for new repositories
724
+ *
725
+ * @schema FirestartrGithubOrganizationSettingsSpec#dependencyGraphEnabledForNewRepositories
726
+ */
727
+ readonly dependencyGraphEnabledForNewRepositories?: boolean;
728
+ /**
729
+ * Whether secret scanning is enabled for new repositories
730
+ *
731
+ * @schema FirestartrGithubOrganizationSettingsSpec#secretScanningEnabledForNewRepositories
732
+ */
733
+ readonly secretScanningEnabledForNewRepositories?: boolean;
734
+ /**
735
+ * Whether secret scanning push protection is enabled for new repositories
736
+ *
737
+ * @schema FirestartrGithubOrganizationSettingsSpec#secretScanningPushProtectionEnabledForNewRepositories
738
+ */
739
+ readonly secretScanningPushProtectionEnabledForNewRepositories?: boolean;
740
+ /**
741
+ * @schema FirestartrGithubOrganizationSettingsSpec#context
742
+ */
743
+ readonly context: FirestartrGithubOrganizationSettingsSpecContext;
744
+ /**
745
+ * @schema FirestartrGithubOrganizationSettingsSpec#firestartr
746
+ */
747
+ readonly firestartr: FirestartrGithubOrganizationSettingsSpecFirestartr;
748
+ /**
749
+ * @schema FirestartrGithubOrganizationSettingsSpec#writeConnectionSecretToRef
750
+ */
751
+ readonly writeConnectionSecretToRef: FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRef;
752
+ }
753
+ /**
754
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpec' to JSON representation.
755
+ */
756
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpec(obj: FirestartrGithubOrganizationSettingsSpec | undefined): Record<string, any> | undefined;
757
+ /**
758
+ * Default repository permission for organization members
759
+ *
760
+ * @schema FirestartrGithubOrganizationSettingsSpecDefaultRepositoryPermission
761
+ */
762
+ export declare enum FirestartrGithubOrganizationSettingsSpecDefaultRepositoryPermission {
763
+ /** read */
764
+ READ = "read",
765
+ /** write */
766
+ WRITE = "write",
767
+ /** admin */
768
+ ADMIN = "admin",
769
+ /** none */
770
+ NONE = "none"
771
+ }
772
+ /**
773
+ * @schema FirestartrGithubOrganizationSettingsSpecContext
774
+ */
775
+ export interface FirestartrGithubOrganizationSettingsSpecContext {
776
+ /**
777
+ * @schema FirestartrGithubOrganizationSettingsSpecContext#backend
778
+ */
779
+ readonly backend: FirestartrGithubOrganizationSettingsSpecContextBackend;
780
+ /**
781
+ * @schema FirestartrGithubOrganizationSettingsSpecContext#provider
782
+ */
783
+ readonly provider: FirestartrGithubOrganizationSettingsSpecContextProvider;
784
+ }
785
+ /**
786
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpecContext' to JSON representation.
787
+ */
788
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpecContext(obj: FirestartrGithubOrganizationSettingsSpecContext | undefined): Record<string, any> | undefined;
789
+ /**
790
+ * @schema FirestartrGithubOrganizationSettingsSpecFirestartr
791
+ */
792
+ export interface FirestartrGithubOrganizationSettingsSpecFirestartr {
793
+ /**
794
+ * @schema FirestartrGithubOrganizationSettingsSpecFirestartr#tfStateKey
795
+ */
796
+ readonly tfStateKey: string;
797
+ }
798
+ /**
799
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpecFirestartr' to JSON representation.
800
+ */
801
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpecFirestartr(obj: FirestartrGithubOrganizationSettingsSpecFirestartr | undefined): Record<string, any> | undefined;
802
+ /**
803
+ * @schema FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRef
804
+ */
805
+ export interface FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRef {
806
+ /**
807
+ * @schema FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRef#name
808
+ */
809
+ readonly name: string;
810
+ /**
811
+ * @schema FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRef#outputs
812
+ */
813
+ readonly outputs: FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRefOutputs[];
814
+ }
815
+ /**
816
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRef' to JSON representation.
817
+ */
818
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRef(obj: FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRef | undefined): Record<string, any> | undefined;
819
+ /**
820
+ * @schema FirestartrGithubOrganizationSettingsSpecContextBackend
821
+ */
822
+ export interface FirestartrGithubOrganizationSettingsSpecContextBackend {
823
+ /**
824
+ * @schema FirestartrGithubOrganizationSettingsSpecContextBackend#ref
825
+ */
826
+ readonly ref: FirestartrGithubOrganizationSettingsSpecContextBackendRef;
827
+ }
828
+ /**
829
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpecContextBackend' to JSON representation.
830
+ */
831
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpecContextBackend(obj: FirestartrGithubOrganizationSettingsSpecContextBackend | undefined): Record<string, any> | undefined;
832
+ /**
833
+ * @schema FirestartrGithubOrganizationSettingsSpecContextProvider
834
+ */
835
+ export interface FirestartrGithubOrganizationSettingsSpecContextProvider {
836
+ /**
837
+ * @schema FirestartrGithubOrganizationSettingsSpecContextProvider#ref
838
+ */
839
+ readonly ref: FirestartrGithubOrganizationSettingsSpecContextProviderRef;
840
+ }
841
+ /**
842
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpecContextProvider' to JSON representation.
843
+ */
844
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpecContextProvider(obj: FirestartrGithubOrganizationSettingsSpecContextProvider | undefined): Record<string, any> | undefined;
845
+ /**
846
+ * @schema FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRefOutputs
847
+ */
848
+ export interface FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRefOutputs {
849
+ /**
850
+ * @schema FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRefOutputs#key
851
+ */
852
+ readonly key: string;
853
+ }
854
+ /**
855
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRefOutputs' to JSON representation.
856
+ */
857
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRefOutputs(obj: FirestartrGithubOrganizationSettingsSpecWriteConnectionSecretToRefOutputs | undefined): Record<string, any> | undefined;
858
+ /**
859
+ * @schema FirestartrGithubOrganizationSettingsSpecContextBackendRef
860
+ */
861
+ export interface FirestartrGithubOrganizationSettingsSpecContextBackendRef {
862
+ /**
863
+ * @schema FirestartrGithubOrganizationSettingsSpecContextBackendRef#kind
864
+ */
865
+ readonly kind: FirestartrGithubOrganizationSettingsSpecContextBackendRefKind;
866
+ /**
867
+ * @schema FirestartrGithubOrganizationSettingsSpecContextBackendRef#name
868
+ */
869
+ readonly name: string;
870
+ }
871
+ /**
872
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpecContextBackendRef' to JSON representation.
873
+ */
874
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpecContextBackendRef(obj: FirestartrGithubOrganizationSettingsSpecContextBackendRef | undefined): Record<string, any> | undefined;
875
+ /**
876
+ * @schema FirestartrGithubOrganizationSettingsSpecContextProviderRef
877
+ */
878
+ export interface FirestartrGithubOrganizationSettingsSpecContextProviderRef {
879
+ /**
880
+ * @schema FirestartrGithubOrganizationSettingsSpecContextProviderRef#kind
881
+ */
882
+ readonly kind: FirestartrGithubOrganizationSettingsSpecContextProviderRefKind;
883
+ /**
884
+ * @schema FirestartrGithubOrganizationSettingsSpecContextProviderRef#name
885
+ */
886
+ readonly name: string;
887
+ }
888
+ /**
889
+ * Converts an object of type 'FirestartrGithubOrganizationSettingsSpecContextProviderRef' to JSON representation.
890
+ */
891
+ export declare function toJson_FirestartrGithubOrganizationSettingsSpecContextProviderRef(obj: FirestartrGithubOrganizationSettingsSpecContextProviderRef | undefined): Record<string, any> | undefined;
892
+ /**
893
+ * @schema FirestartrGithubOrganizationSettingsSpecContextBackendRefKind
894
+ */
895
+ export declare enum FirestartrGithubOrganizationSettingsSpecContextBackendRefKind {
896
+ /** FirestartrProviderConfig */
897
+ FIRESTARTR_PROVIDER_CONFIG = "FirestartrProviderConfig"
898
+ }
899
+ /**
900
+ * @schema FirestartrGithubOrganizationSettingsSpecContextProviderRefKind
901
+ */
902
+ export declare enum FirestartrGithubOrganizationSettingsSpecContextProviderRefKind {
903
+ /** FirestartrProviderConfig */
904
+ FIRESTARTR_PROVIDER_CONFIG = "FirestartrProviderConfig"
905
+ }
525
906
  /**
526
907
  * A resource to handle GitHub Organization Webhooks
527
908
  *
@@ -12,11 +12,6 @@ type PatchData = {
12
12
  };
13
13
  export { PatchOperations, PatchData };
14
14
  export declare abstract class Entity {
15
- parent?: Entity;
16
- _terraformHasRun?: boolean;
17
- sessionId?: string;
18
- sessionProjectPath?: string;
19
- __ghProvisionerSessionWorkspaceInitialized?: boolean;
20
15
  static refResolver: RefResolver;
21
16
  static setRefResolver(refResolver: RefResolver): void;
22
17
  _cr: EntityCR;
@@ -1,6 +1,6 @@
1
1
  import { Entity } from './entities';
2
2
  export declare function runOnTerraform(entity: Entity, command: string, customArgs?: any[], opts?: any): Promise<any>;
3
- export declare function buildContext(entity: Entity, reuseExistingProjectOverride?: boolean, importMode?: boolean): {
3
+ export declare function buildContext(entity: Entity): {
4
4
  type: string;
5
5
  inline: string;
6
6
  module: string;
@@ -12,6 +12,4 @@ export declare function buildContext(entity: Entity, reuseExistingProjectOverrid
12
12
  tfStatePath: string;
13
13
  references: {};
14
14
  projectPath: string;
15
- reuseExistingProject: boolean;
16
- importMode: boolean;
17
15
  };
@@ -4,6 +4,8 @@ import { getOctokitForOrg, getGithubAppToken, getOctokitFromPat } from './src/au
4
4
  import { encryptRepoSecret, getRepoPublicKey } from './src/encrypt';
5
5
  import type { RepoSecretsSection } from './src/encrypt';
6
6
  import type { WorkflowCompletionResult, WorkflowDispatchInputs, WorkflowRunConclusion, WorkflowRunStatus, WorkflowRunStatusFilter, WorkflowRunSummary } from './src/workflow';
7
+ import { withProfile } from './src/with_profile';
8
+ import { createProfile } from './src/profile';
7
9
  declare const _default: {
8
10
  org: {
9
11
  getRepositoryList: typeof import("./src/organization").getRepositoryList;
@@ -71,11 +73,11 @@ declare const _default: {
71
73
  }) => Promise<any>;
72
74
  };
73
75
  issues: {
74
- create: (owner: string, repo: string, title: string, body: string, labels?: string[]) => Promise<any>;
75
- update: (owner: string, repo: string, issue_number: number, title: string, body: string, labels?: string[]) => Promise<any>;
76
- close: (owner: string, repo: string, issue_number: number) => Promise<any>;
77
- filterBy: (owner: string, repo: string, title: string, labels: string, state?: "all" | "closed" | "open", creator?: string, assignee?: string) => Promise<any>;
78
- upsertByTitle: (owner: string, repo: string, title: string, body: string, labels?: string[]) => Promise<any>;
76
+ create: (owner: string, repo: string, title: string, body: string, labels?: string[], octokit?: any) => Promise<any>;
77
+ update: (owner: string, repo: string, issue_number: number, title: string, body: string, labels?: string[], octokit?: any) => Promise<any>;
78
+ close: (owner: string, repo: string, issue_number: number, octokit?: any) => Promise<any>;
79
+ filterBy: (owner: string, repo: string, title: string, labels: string, state?: "all" | "closed" | "open", creator?: string, assignee?: string, octokit?: any) => Promise<any>;
80
+ upsertByTitle: (owner: string, repo: string, title: string, body: string, labels?: string[], octokit?: any) => Promise<any>;
79
81
  };
80
82
  branches: {
81
83
  listBranches: typeof import("./src/branches").listBranches;
@@ -98,7 +100,9 @@ declare const _default: {
98
100
  encryptRepoSecret: typeof encryptRepoSecret;
99
101
  getRepoPublicKey: typeof getRepoPublicKey;
100
102
  };
103
+ withProfile: typeof withProfile;
104
+ createProfile: typeof createProfile;
101
105
  };
102
106
  export default _default;
103
- export { RepoSecretsSection };
107
+ export { RepoSecretsSection, createProfile };
104
108
  export type { WorkflowCompletionResult, WorkflowDispatchInputs, WorkflowRunConclusion, WorkflowRunStatus, WorkflowRunStatusFilter, WorkflowRunSummary, };
@@ -3,11 +3,14 @@ import type { Api } from '@octokit/plugin-rest-endpoint-methods/dist-types/types
3
3
  import type { PaginateInterface } from '@octokit/plugin-paginate-rest/dist-types/types';
4
4
  import type { paginateGraphQLInterface } from '@octokit/plugin-paginate-graphql/dist-types/index.js';
5
5
  export declare const generateGithubAppToken: (config: any) => Promise<string>;
6
+ type GithubAuthConfig = import('./config_resolver').GithubAuthConfig;
7
+ export declare function getGithubAppTokenWithConfig(config: GithubAuthConfig, genGithubAppToken?: any): Promise<string>;
6
8
  export declare function getGithubAppToken(org: string, genGithubAppToken?: any): Promise<string>;
7
9
  type ExtendedOctokit = Octokit & Api & {
8
10
  paginate: PaginateInterface;
9
11
  } & paginateGraphQLInterface;
10
12
  export { ExtendedOctokit };
13
+ export declare function getOctokitForOrgWithConfig(org: string, config: GithubAuthConfig, paginated?: boolean, genGithubAppToken?: any): Promise<ExtendedOctokit>;
11
14
  export declare function getOctokitForOrg(org: string, paginated?: boolean, genGithubAppToken?: any): Promise<ExtendedOctokit>;
12
15
  export declare function getOctokitFromPat(envVar: string): Promise<ExtendedOctokit>;
13
16
  declare const _default: {
@@ -1,2 +1,3 @@
1
+ export declare function getInstallationIDWithConfig(org: string, config: any): Promise<any>;
1
2
  export declare function getInstallationID(org?: string): Promise<any>;
2
3
  export declare function checkIfInstalledForOrg(org?: string): Promise<boolean>;