UNPKG

1.95 kBTypeScriptView Raw
1import { ConfigValue } from '../config/configStackTypes';
2export declare enum OrgConfigProperties {
3 /**
4 * Username associate with the default org.
5 */
6 TARGET_ORG = "target-org",
7 /**
8 * Username associated with the default dev hub org.
9 */
10 TARGET_DEV_HUB = "target-dev-hub",
11 /**
12 * The api version
13 */
14 ORG_API_VERSION = "org-api-version",
15 /**
16 * Custom templates repo or local location.
17 */
18 ORG_CUSTOM_METADATA_TEMPLATES = "org-custom-metadata-templates",
19 /**
20 * Allows users to override the 10,000 result query limit.
21 */
22 ORG_MAX_QUERY_LIMIT = "org-max-query-limit",
23 /**
24 * The instance url of the org.
25 */
26 ORG_INSTANCE_URL = "org-instance-url",
27 /**
28 * The sid for the debugger configuration.
29 */
30 ORG_ISV_DEBUGGER_SID = "org-isv-debugger-sid",
31 /**
32 * The url for the debugger configuration.
33 */
34 ORG_ISV_DEBUGGER_URL = "org-isv-debugger-url",
35 /**
36 * Capitalize record types when deploying scratch org settings
37 */
38 ORG_CAPITALIZE_RECORD_TYPES = "org-capitalize-record-types"
39}
40export declare const ORG_CONFIG_ALLOWED_PROPERTIES: ({
41 key: OrgConfigProperties;
42 description: string;
43 input?: undefined;
44 hidden?: undefined;
45 encrypted?: undefined;
46} | {
47 key: OrgConfigProperties;
48 description: string;
49 input: {
50 validator: (value: ConfigValue) => boolean;
51 failedMessage: string;
52 };
53 hidden?: undefined;
54 encrypted?: undefined;
55} | {
56 key: OrgConfigProperties;
57 description: string;
58 hidden: boolean;
59 input: {
60 validator: (value: ConfigValue) => boolean;
61 failedMessage: string;
62 };
63 encrypted?: undefined;
64} | {
65 key: OrgConfigProperties;
66 description: string;
67 encrypted: boolean;
68 input: {
69 validator: (value: ConfigValue) => boolean;
70 failedMessage: string;
71 };
72 hidden?: undefined;
73})[];