@salesforce/core 3.30.14 → 3.31.7
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.
- package/LICENSE.txt +11 -11
- package/README.md +222 -227
- package/lib/config/aliasesConfig.d.ts +12 -12
- package/lib/config/aliasesConfig.js +27 -27
- package/lib/config/authInfoConfig.d.ts +19 -19
- package/lib/config/authInfoConfig.js +34 -34
- package/lib/config/config.d.ts +311 -311
- package/lib/config/config.js +574 -574
- package/lib/config/configAggregator.d.ts +232 -232
- package/lib/config/configAggregator.js +379 -379
- package/lib/config/configFile.d.ts +199 -199
- package/lib/config/configFile.js +340 -340
- package/lib/config/configGroup.d.ts +141 -141
- package/lib/config/configGroup.js +224 -224
- package/lib/config/configStore.d.ts +241 -241
- package/lib/config/configStore.js +352 -352
- package/lib/config/envVars.d.ts +101 -101
- package/lib/config/envVars.js +456 -456
- package/lib/config/orgUsersConfig.d.ts +31 -31
- package/lib/config/orgUsersConfig.js +41 -41
- package/lib/config/sandboxOrgConfig.d.ts +37 -37
- package/lib/config/sandboxOrgConfig.js +50 -50
- package/lib/config/sandboxProcessCache.d.ts +16 -16
- package/lib/config/sandboxProcessCache.js +37 -37
- package/lib/config/tokensConfig.d.ts +10 -10
- package/lib/config/tokensConfig.js +28 -28
- package/lib/config/ttlConfig.d.ts +34 -34
- package/lib/config/ttlConfig.js +54 -54
- package/lib/crypto/crypto.d.ts +54 -54
- package/lib/crypto/crypto.js +220 -220
- package/lib/crypto/keyChain.d.ts +8 -8
- package/lib/crypto/keyChain.js +61 -61
- package/lib/crypto/keyChainImpl.d.ts +116 -116
- package/lib/crypto/keyChainImpl.js +486 -486
- package/lib/crypto/secureBuffer.d.ts +46 -46
- package/lib/crypto/secureBuffer.js +82 -82
- package/lib/deviceOauthService.d.ts +71 -71
- package/lib/deviceOauthService.js +191 -191
- package/lib/exported.d.ts +38 -38
- package/lib/exported.js +118 -118
- package/lib/global.d.ts +70 -70
- package/lib/global.js +109 -109
- package/lib/lifecycleEvents.d.ts +93 -93
- package/lib/lifecycleEvents.js +188 -188
- package/lib/logger.d.ts +381 -381
- package/lib/logger.js +734 -734
- package/lib/messages.d.ts +291 -291
- package/lib/messages.js +543 -543
- package/lib/org/authInfo.d.ts +344 -344
- package/lib/org/authInfo.js +892 -892
- package/lib/org/authRemover.d.ts +88 -88
- package/lib/org/authRemover.js +182 -182
- package/lib/org/connection.d.ts +197 -197
- package/lib/org/connection.js +395 -395
- package/lib/org/index.d.ts +6 -6
- package/lib/org/index.js +28 -28
- package/lib/org/org.d.ts +558 -558
- package/lib/org/org.js +1267 -1267
- package/lib/org/orgConfigProperties.d.ts +69 -69
- package/lib/org/orgConfigProperties.js +136 -136
- package/lib/org/permissionSetAssignment.d.ts +35 -35
- package/lib/org/permissionSetAssignment.js +125 -125
- package/lib/org/scratchOrgCache.d.ts +20 -20
- package/lib/org/scratchOrgCache.js +32 -32
- package/lib/org/scratchOrgCreate.d.ts +54 -54
- package/lib/org/scratchOrgCreate.js +216 -216
- package/lib/org/scratchOrgErrorCodes.d.ts +10 -10
- package/lib/org/scratchOrgErrorCodes.js +88 -88
- package/lib/org/scratchOrgFeatureDeprecation.d.ts +26 -26
- package/lib/org/scratchOrgFeatureDeprecation.js +109 -109
- package/lib/org/scratchOrgInfoApi.d.ts +68 -68
- package/lib/org/scratchOrgInfoApi.js +413 -413
- package/lib/org/scratchOrgInfoGenerator.d.ts +64 -64
- package/lib/org/scratchOrgInfoGenerator.js +241 -241
- package/lib/org/scratchOrgLifecycleEvents.d.ts +10 -10
- package/lib/org/scratchOrgLifecycleEvents.js +40 -40
- package/lib/org/scratchOrgSettingsGenerator.d.ts +78 -78
- package/lib/org/scratchOrgSettingsGenerator.js +276 -276
- package/lib/org/scratchOrgTypes.d.ts +43 -43
- package/lib/org/scratchOrgTypes.js +8 -8
- package/lib/org/user.d.ts +187 -187
- package/lib/org/user.js +448 -448
- package/lib/schema/printer.d.ts +79 -79
- package/lib/schema/printer.js +260 -260
- package/lib/schema/validator.d.ts +70 -70
- package/lib/schema/validator.js +169 -169
- package/lib/sfError.d.ts +73 -73
- package/lib/sfError.js +136 -136
- package/lib/sfProject.d.ts +357 -357
- package/lib/sfProject.js +671 -671
- package/lib/stateAggregator/accessors/aliasAccessor.d.ts +98 -98
- package/lib/stateAggregator/accessors/aliasAccessor.js +145 -145
- package/lib/stateAggregator/accessors/orgAccessor.d.ts +101 -101
- package/lib/stateAggregator/accessors/orgAccessor.js +240 -240
- package/lib/stateAggregator/accessors/sandboxAccessor.d.ts +8 -8
- package/lib/stateAggregator/accessors/sandboxAccessor.js +27 -27
- package/lib/stateAggregator/accessors/tokenAccessor.d.ts +63 -63
- package/lib/stateAggregator/accessors/tokenAccessor.js +79 -79
- package/lib/stateAggregator/index.d.ts +4 -4
- package/lib/stateAggregator/index.js +26 -26
- package/lib/stateAggregator/stateAggregator.d.ts +25 -25
- package/lib/stateAggregator/stateAggregator.js +45 -45
- package/lib/status/myDomainResolver.d.ts +66 -66
- package/lib/status/myDomainResolver.js +124 -124
- package/lib/status/pollingClient.d.ts +85 -85
- package/lib/status/pollingClient.js +115 -115
- package/lib/status/streamingClient.d.ts +244 -244
- package/lib/status/streamingClient.js +436 -436
- package/lib/status/types.d.ts +89 -89
- package/lib/status/types.js +17 -17
- package/lib/testSetup.d.ts +553 -530
- package/lib/testSetup.js +871 -727
- package/lib/util/cache.d.ts +11 -11
- package/lib/util/cache.js +69 -69
- package/lib/util/checkLightningDomain.d.ts +1 -1
- package/lib/util/checkLightningDomain.js +28 -28
- package/lib/util/directoryWriter.d.ts +12 -12
- package/lib/util/directoryWriter.js +53 -53
- package/lib/util/getJwtAudienceUrl.d.ts +4 -4
- package/lib/util/getJwtAudienceUrl.js +18 -18
- package/lib/util/internal.d.ts +58 -58
- package/lib/util/internal.js +118 -118
- package/lib/util/jsonXmlTools.d.ts +14 -14
- package/lib/util/jsonXmlTools.js +38 -38
- package/lib/util/mapKeys.d.ts +14 -14
- package/lib/util/mapKeys.js +51 -51
- package/lib/util/sfdc.d.ts +52 -52
- package/lib/util/sfdc.js +85 -85
- package/lib/util/sfdcUrl.d.ts +72 -72
- package/lib/util/sfdcUrl.js +215 -215
- package/lib/util/structuredWriter.d.ts +9 -9
- package/lib/util/structuredWriter.js +2 -2
- package/lib/util/zipWriter.d.ts +16 -16
- package/lib/util/zipWriter.js +67 -67
- package/lib/webOAuthServer.d.ts +156 -156
- package/lib/webOAuthServer.js +388 -388
- package/messages/auth.md +37 -37
- package/messages/config.md +156 -156
- package/messages/connection.md +30 -30
- package/messages/core.json +20 -20
- package/messages/core.md +67 -67
- package/messages/encryption.md +85 -85
- package/messages/envVars.md +303 -303
- package/messages/org.md +63 -63
- package/messages/permissionSetAssignment.md +31 -31
- package/messages/scratchOrgCreate.md +23 -23
- package/messages/scratchOrgErrorCodes.md +115 -115
- package/messages/scratchOrgFeatureDeprecation.md +11 -11
- package/messages/scratchOrgInfoApi.md +15 -15
- package/messages/scratchOrgInfoGenerator.md +23 -23
- package/messages/streaming.md +23 -23
- package/messages/user.md +35 -35
- package/package.json +97 -97
|
@@ -1,126 +1,126 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*
|
|
3
|
-
* Copyright (c) 2020, salesforce.com, inc.
|
|
4
|
-
* All rights reserved.
|
|
5
|
-
* Licensed under the BSD 3-Clause license.
|
|
6
|
-
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
|
-
*/
|
|
8
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.PermissionSetAssignment = void 0;
|
|
10
|
-
const os_1 = require("os");
|
|
11
|
-
const kit_1 = require("@salesforce/kit");
|
|
12
|
-
const ts_types_1 = require("@salesforce/ts-types");
|
|
13
|
-
const logger_1 = require("../logger");
|
|
14
|
-
const messages_1 = require("../messages");
|
|
15
|
-
const sfError_1 = require("../sfError");
|
|
16
|
-
messages_1.Messages.importMessagesDirectory(__dirname);
|
|
17
|
-
const messages = messages_1.Messages.load('@salesforce/core', 'permissionSetAssignment', [
|
|
18
|
-
'errorsEncounteredCreatingAssignment',
|
|
19
|
-
'orgRequired',
|
|
20
|
-
'userIdRequired',
|
|
21
|
-
'permSetRequired',
|
|
22
|
-
'assignCommandPermissionSetNotFoundForNSError',
|
|
23
|
-
'assignCommandPermissionSetNotFoundError',
|
|
24
|
-
'notSuccessfulButNoErrorsReported',
|
|
25
|
-
]);
|
|
26
|
-
/**
|
|
27
|
-
* A class for assigning a Salesforce User to one or more permission sets.
|
|
28
|
-
*/
|
|
29
|
-
class PermissionSetAssignment {
|
|
30
|
-
constructor(org, logger) {
|
|
31
|
-
this.logger = logger;
|
|
32
|
-
this.org = org;
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* Creates a new instance of PermissionSetAssignment.
|
|
36
|
-
*
|
|
37
|
-
* @param org The target org for the assignment.
|
|
38
|
-
*/
|
|
39
|
-
static async init(org) {
|
|
40
|
-
if (!org) {
|
|
41
|
-
throw messages.createError('orgRequired');
|
|
42
|
-
}
|
|
43
|
-
return new PermissionSetAssignment(org, await logger_1.Logger.child('PermissionSetAssignment'));
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* Assigns a user to one or more permission sets.
|
|
47
|
-
*
|
|
48
|
-
* @param id A user id
|
|
49
|
-
* @param permSetString An array of permission set names.
|
|
50
|
-
*/
|
|
51
|
-
async create(id, permSetString) {
|
|
52
|
-
if (!id) {
|
|
53
|
-
throw messages.createError('userIdRequired');
|
|
54
|
-
}
|
|
55
|
-
if (!permSetString) {
|
|
56
|
-
throw messages.createError('permSetRequired');
|
|
57
|
-
}
|
|
58
|
-
const { nsPrefix, permSetName } = this.parsePermissionSetString(permSetString);
|
|
59
|
-
let query = `SELECT Id FROM PermissionSet WHERE Name='${permSetName}'`;
|
|
60
|
-
if (nsPrefix) {
|
|
61
|
-
query += ` AND NamespacePrefix='${nsPrefix}'`;
|
|
62
|
-
}
|
|
63
|
-
const result = await this.org.getConnection().query(query);
|
|
64
|
-
const permissionSetId = result?.records[0]?.Id;
|
|
65
|
-
if (!permissionSetId) {
|
|
66
|
-
if (nsPrefix) {
|
|
67
|
-
throw messages.createError('assignCommandPermissionSetNotFoundForNSError', [permSetName, nsPrefix]);
|
|
68
|
-
}
|
|
69
|
-
else {
|
|
70
|
-
throw messages.createError('assignCommandPermissionSetNotFoundError', [permSetName]);
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
const assignment = {
|
|
74
|
-
assigneeId: id,
|
|
75
|
-
permissionSetId,
|
|
76
|
-
};
|
|
77
|
-
const createResponse = await this.org
|
|
78
|
-
.getConnection()
|
|
79
|
-
.sobject('PermissionSetAssignment')
|
|
80
|
-
.create((0, kit_1.mapKeys)(assignment, (value, key) => (0, kit_1.upperFirst)(key)));
|
|
81
|
-
if ((0, ts_types_1.hasArray)(createResponse, 'errors') && createResponse.errors.length > 0) {
|
|
82
|
-
let message = messages.getMessage('errorsEncounteredCreatingAssignment');
|
|
83
|
-
const errors = createResponse.errors;
|
|
84
|
-
if (errors && errors.length > 0) {
|
|
85
|
-
message = `${message}:${os_1.EOL}`;
|
|
86
|
-
errors.forEach((_message) => {
|
|
87
|
-
message = `${message}${_message}${os_1.EOL}`;
|
|
88
|
-
});
|
|
89
|
-
throw new sfError_1.SfError(message, 'errorsEncounteredCreatingAssignment');
|
|
90
|
-
}
|
|
91
|
-
else {
|
|
92
|
-
throw messages.createError('notSuccessfulButNoErrorsReported');
|
|
93
|
-
}
|
|
94
|
-
}
|
|
95
|
-
else {
|
|
96
|
-
return assignment;
|
|
97
|
-
}
|
|
98
|
-
}
|
|
99
|
-
/**
|
|
100
|
-
* Parses a permission set name based on if it has a namespace or not.
|
|
101
|
-
*
|
|
102
|
-
* @param permSetString The permission set string.
|
|
103
|
-
*/
|
|
104
|
-
parsePermissionSetString(permSetString) {
|
|
105
|
-
const nsPrefixMatch = RegExp(/(\w+(?=__))(__)(.*)/).exec(permSetString);
|
|
106
|
-
let nsPrefix;
|
|
107
|
-
let permSetName;
|
|
108
|
-
if (nsPrefixMatch) {
|
|
109
|
-
try {
|
|
110
|
-
nsPrefix = nsPrefixMatch[1];
|
|
111
|
-
permSetName = nsPrefixMatch[3];
|
|
112
|
-
this.logger.debug(`Using namespacePrefix ${nsPrefix} for permission set ${permSetName}`);
|
|
113
|
-
}
|
|
114
|
-
catch (e) {
|
|
115
|
-
// Don't fail if we parse wrong.
|
|
116
|
-
this.logger.debug(e);
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
else {
|
|
120
|
-
permSetName = permSetString;
|
|
121
|
-
}
|
|
122
|
-
return { nsPrefix, permSetName };
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
exports.PermissionSetAssignment = PermissionSetAssignment;
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Copyright (c) 2020, salesforce.com, inc.
|
|
4
|
+
* All rights reserved.
|
|
5
|
+
* Licensed under the BSD 3-Clause license.
|
|
6
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
|
+
*/
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.PermissionSetAssignment = void 0;
|
|
10
|
+
const os_1 = require("os");
|
|
11
|
+
const kit_1 = require("@salesforce/kit");
|
|
12
|
+
const ts_types_1 = require("@salesforce/ts-types");
|
|
13
|
+
const logger_1 = require("../logger");
|
|
14
|
+
const messages_1 = require("../messages");
|
|
15
|
+
const sfError_1 = require("../sfError");
|
|
16
|
+
messages_1.Messages.importMessagesDirectory(__dirname);
|
|
17
|
+
const messages = messages_1.Messages.load('@salesforce/core', 'permissionSetAssignment', [
|
|
18
|
+
'errorsEncounteredCreatingAssignment',
|
|
19
|
+
'orgRequired',
|
|
20
|
+
'userIdRequired',
|
|
21
|
+
'permSetRequired',
|
|
22
|
+
'assignCommandPermissionSetNotFoundForNSError',
|
|
23
|
+
'assignCommandPermissionSetNotFoundError',
|
|
24
|
+
'notSuccessfulButNoErrorsReported',
|
|
25
|
+
]);
|
|
26
|
+
/**
|
|
27
|
+
* A class for assigning a Salesforce User to one or more permission sets.
|
|
28
|
+
*/
|
|
29
|
+
class PermissionSetAssignment {
|
|
30
|
+
constructor(org, logger) {
|
|
31
|
+
this.logger = logger;
|
|
32
|
+
this.org = org;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Creates a new instance of PermissionSetAssignment.
|
|
36
|
+
*
|
|
37
|
+
* @param org The target org for the assignment.
|
|
38
|
+
*/
|
|
39
|
+
static async init(org) {
|
|
40
|
+
if (!org) {
|
|
41
|
+
throw messages.createError('orgRequired');
|
|
42
|
+
}
|
|
43
|
+
return new PermissionSetAssignment(org, await logger_1.Logger.child('PermissionSetAssignment'));
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Assigns a user to one or more permission sets.
|
|
47
|
+
*
|
|
48
|
+
* @param id A user id
|
|
49
|
+
* @param permSetString An array of permission set names.
|
|
50
|
+
*/
|
|
51
|
+
async create(id, permSetString) {
|
|
52
|
+
if (!id) {
|
|
53
|
+
throw messages.createError('userIdRequired');
|
|
54
|
+
}
|
|
55
|
+
if (!permSetString) {
|
|
56
|
+
throw messages.createError('permSetRequired');
|
|
57
|
+
}
|
|
58
|
+
const { nsPrefix, permSetName } = this.parsePermissionSetString(permSetString);
|
|
59
|
+
let query = `SELECT Id FROM PermissionSet WHERE Name='${permSetName}'`;
|
|
60
|
+
if (nsPrefix) {
|
|
61
|
+
query += ` AND NamespacePrefix='${nsPrefix}'`;
|
|
62
|
+
}
|
|
63
|
+
const result = await this.org.getConnection().query(query);
|
|
64
|
+
const permissionSetId = result?.records[0]?.Id;
|
|
65
|
+
if (!permissionSetId) {
|
|
66
|
+
if (nsPrefix) {
|
|
67
|
+
throw messages.createError('assignCommandPermissionSetNotFoundForNSError', [permSetName, nsPrefix]);
|
|
68
|
+
}
|
|
69
|
+
else {
|
|
70
|
+
throw messages.createError('assignCommandPermissionSetNotFoundError', [permSetName]);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
const assignment = {
|
|
74
|
+
assigneeId: id,
|
|
75
|
+
permissionSetId,
|
|
76
|
+
};
|
|
77
|
+
const createResponse = await this.org
|
|
78
|
+
.getConnection()
|
|
79
|
+
.sobject('PermissionSetAssignment')
|
|
80
|
+
.create((0, kit_1.mapKeys)(assignment, (value, key) => (0, kit_1.upperFirst)(key)));
|
|
81
|
+
if ((0, ts_types_1.hasArray)(createResponse, 'errors') && createResponse.errors.length > 0) {
|
|
82
|
+
let message = messages.getMessage('errorsEncounteredCreatingAssignment');
|
|
83
|
+
const errors = createResponse.errors;
|
|
84
|
+
if (errors && errors.length > 0) {
|
|
85
|
+
message = `${message}:${os_1.EOL}`;
|
|
86
|
+
errors.forEach((_message) => {
|
|
87
|
+
message = `${message}${_message}${os_1.EOL}`;
|
|
88
|
+
});
|
|
89
|
+
throw new sfError_1.SfError(message, 'errorsEncounteredCreatingAssignment');
|
|
90
|
+
}
|
|
91
|
+
else {
|
|
92
|
+
throw messages.createError('notSuccessfulButNoErrorsReported');
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
else {
|
|
96
|
+
return assignment;
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Parses a permission set name based on if it has a namespace or not.
|
|
101
|
+
*
|
|
102
|
+
* @param permSetString The permission set string.
|
|
103
|
+
*/
|
|
104
|
+
parsePermissionSetString(permSetString) {
|
|
105
|
+
const nsPrefixMatch = RegExp(/(\w+(?=__))(__)(.*)/).exec(permSetString);
|
|
106
|
+
let nsPrefix;
|
|
107
|
+
let permSetName;
|
|
108
|
+
if (nsPrefixMatch) {
|
|
109
|
+
try {
|
|
110
|
+
nsPrefix = nsPrefixMatch[1];
|
|
111
|
+
permSetName = nsPrefixMatch[3];
|
|
112
|
+
this.logger.debug(`Using namespacePrefix ${nsPrefix} for permission set ${permSetName}`);
|
|
113
|
+
}
|
|
114
|
+
catch (e) {
|
|
115
|
+
// Don't fail if we parse wrong.
|
|
116
|
+
this.logger.debug(e);
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
else {
|
|
120
|
+
permSetName = permSetString;
|
|
121
|
+
}
|
|
122
|
+
return { nsPrefix, permSetName };
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
exports.PermissionSetAssignment = PermissionSetAssignment;
|
|
126
126
|
//# sourceMappingURL=permissionSetAssignment.js.map
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
import { JsonMap } from '@salesforce/ts-types';
|
|
2
|
-
import { TTLConfig } from '../config/ttlConfig';
|
|
3
|
-
export declare type CachedOptions = {
|
|
4
|
-
hubUsername: string;
|
|
5
|
-
/** stores the scratch definition, including settings/objectSettings */
|
|
6
|
-
definitionjson: JsonMap;
|
|
7
|
-
hubBaseUrl: string;
|
|
8
|
-
/** may be required for auth*/
|
|
9
|
-
clientSecret?: string;
|
|
10
|
-
signupTargetLoginUrlConfig?: string;
|
|
11
|
-
apiVersion?: string;
|
|
12
|
-
alias?: string;
|
|
13
|
-
setDefault?: boolean;
|
|
14
|
-
tracksSource?: boolean;
|
|
15
|
-
};
|
|
16
|
-
export declare class ScratchOrgCache extends TTLConfig<TTLConfig.Options, CachedOptions> {
|
|
17
|
-
static getFileName(): string;
|
|
18
|
-
static getDefaultOptions(): TTLConfig.Options;
|
|
19
|
-
static unset(key: string): Promise<void>;
|
|
20
|
-
}
|
|
1
|
+
import { JsonMap } from '@salesforce/ts-types';
|
|
2
|
+
import { TTLConfig } from '../config/ttlConfig';
|
|
3
|
+
export declare type CachedOptions = {
|
|
4
|
+
hubUsername: string;
|
|
5
|
+
/** stores the scratch definition, including settings/objectSettings */
|
|
6
|
+
definitionjson: JsonMap;
|
|
7
|
+
hubBaseUrl: string;
|
|
8
|
+
/** may be required for auth*/
|
|
9
|
+
clientSecret?: string;
|
|
10
|
+
signupTargetLoginUrlConfig?: string;
|
|
11
|
+
apiVersion?: string;
|
|
12
|
+
alias?: string;
|
|
13
|
+
setDefault?: boolean;
|
|
14
|
+
tracksSource?: boolean;
|
|
15
|
+
};
|
|
16
|
+
export declare class ScratchOrgCache extends TTLConfig<TTLConfig.Options, CachedOptions> {
|
|
17
|
+
static getFileName(): string;
|
|
18
|
+
static getDefaultOptions(): TTLConfig.Options;
|
|
19
|
+
static unset(key: string): Promise<void>;
|
|
20
|
+
}
|
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ScratchOrgCache = void 0;
|
|
4
|
-
/*
|
|
5
|
-
* Copyright (c) 2020, salesforce.com, inc.
|
|
6
|
-
* All rights reserved.
|
|
7
|
-
* Licensed under the BSD 3-Clause license.
|
|
8
|
-
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
9
|
-
*/
|
|
10
|
-
const kit_1 = require("@salesforce/kit");
|
|
11
|
-
const global_1 = require("../global");
|
|
12
|
-
const ttlConfig_1 = require("../config/ttlConfig");
|
|
13
|
-
class ScratchOrgCache extends ttlConfig_1.TTLConfig {
|
|
14
|
-
static getFileName() {
|
|
15
|
-
return 'scratch-create-cache.json';
|
|
16
|
-
}
|
|
17
|
-
static getDefaultOptions() {
|
|
18
|
-
return {
|
|
19
|
-
isGlobal: true,
|
|
20
|
-
isState: true,
|
|
21
|
-
filename: ScratchOrgCache.getFileName(),
|
|
22
|
-
stateFolder: global_1.Global.SF_STATE_FOLDER,
|
|
23
|
-
ttl: kit_1.Duration.days(1),
|
|
24
|
-
};
|
|
25
|
-
}
|
|
26
|
-
static async unset(key) {
|
|
27
|
-
const cache = await ScratchOrgCache.create();
|
|
28
|
-
cache.unset(key);
|
|
29
|
-
await cache.write();
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
exports.ScratchOrgCache = ScratchOrgCache;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ScratchOrgCache = void 0;
|
|
4
|
+
/*
|
|
5
|
+
* Copyright (c) 2020, salesforce.com, inc.
|
|
6
|
+
* All rights reserved.
|
|
7
|
+
* Licensed under the BSD 3-Clause license.
|
|
8
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
9
|
+
*/
|
|
10
|
+
const kit_1 = require("@salesforce/kit");
|
|
11
|
+
const global_1 = require("../global");
|
|
12
|
+
const ttlConfig_1 = require("../config/ttlConfig");
|
|
13
|
+
class ScratchOrgCache extends ttlConfig_1.TTLConfig {
|
|
14
|
+
static getFileName() {
|
|
15
|
+
return 'scratch-create-cache.json';
|
|
16
|
+
}
|
|
17
|
+
static getDefaultOptions() {
|
|
18
|
+
return {
|
|
19
|
+
isGlobal: true,
|
|
20
|
+
isState: true,
|
|
21
|
+
filename: ScratchOrgCache.getFileName(),
|
|
22
|
+
stateFolder: global_1.Global.SF_STATE_FOLDER,
|
|
23
|
+
ttl: kit_1.Duration.days(1),
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
static async unset(key) {
|
|
27
|
+
const cache = await ScratchOrgCache.create();
|
|
28
|
+
cache.unset(key);
|
|
29
|
+
await cache.write();
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
exports.ScratchOrgCache = ScratchOrgCache;
|
|
33
33
|
//# sourceMappingURL=scratchOrgCache.js.map
|
|
@@ -1,54 +1,54 @@
|
|
|
1
|
-
import { Duration } from '@salesforce/kit';
|
|
2
|
-
import { Org } from './org';
|
|
3
|
-
import { ScratchOrgInfo } from './scratchOrgTypes';
|
|
4
|
-
import { AuthFields, AuthInfo } from './authInfo';
|
|
5
|
-
export declare const DEFAULT_STREAM_TIMEOUT_MINUTES = 6;
|
|
6
|
-
export interface ScratchOrgCreateResult {
|
|
7
|
-
username?: string;
|
|
8
|
-
scratchOrgInfo?: ScratchOrgInfo;
|
|
9
|
-
authInfo?: AuthInfo;
|
|
10
|
-
authFields?: AuthFields;
|
|
11
|
-
warnings: string[];
|
|
12
|
-
}
|
|
13
|
-
export interface ScratchOrgCreateOptions {
|
|
14
|
-
/** the environment hub org */
|
|
15
|
-
hubOrg: Org;
|
|
16
|
-
/** The connected app consumer key. */
|
|
17
|
-
connectedAppConsumerKey?: string;
|
|
18
|
-
/** duration of the scratch org (in days) (default:1, min:1, max:30) */
|
|
19
|
-
durationDays?: number;
|
|
20
|
-
/** create the scratch org with no namespace */
|
|
21
|
-
nonamespace?: boolean;
|
|
22
|
-
/** create the scratch org with no second-generation package ancestors */
|
|
23
|
-
noancestors?: boolean;
|
|
24
|
-
/** the streaming client socket timeout (in minutes) must be an instance of the Duration utility class (default:6) */
|
|
25
|
-
wait?: Duration;
|
|
26
|
-
/** number of scratch org auth retries after scratch org is successfully signed up (default:0, min:0, max:10) */
|
|
27
|
-
retry?: number;
|
|
28
|
-
/** target server instance API version */
|
|
29
|
-
apiversion?: string;
|
|
30
|
-
/**
|
|
31
|
-
* org definition in JSON format, stringified
|
|
32
|
-
*
|
|
33
|
-
* @deprecated use orgConfig
|
|
34
|
-
*/
|
|
35
|
-
definitionjson?: string;
|
|
36
|
-
/**
|
|
37
|
-
* path to an org definition file
|
|
38
|
-
*
|
|
39
|
-
* @deprecated use orgConfig
|
|
40
|
-
* */
|
|
41
|
-
definitionfile?: string;
|
|
42
|
-
/** overrides definitionjson */
|
|
43
|
-
orgConfig?: Record<string, unknown>;
|
|
44
|
-
/** OAuth client secret of personal connected app */
|
|
45
|
-
clientSecret?: string;
|
|
46
|
-
/** alias to set for the created org */
|
|
47
|
-
alias?: string;
|
|
48
|
-
/** after complete, set the org as the default */
|
|
49
|
-
setDefault?: boolean;
|
|
50
|
-
/** if false, do not use source tracking for this scratch org */
|
|
51
|
-
tracksSource?: boolean;
|
|
52
|
-
}
|
|
53
|
-
export declare const scratchOrgResume: (jobId: string) => Promise<ScratchOrgCreateResult>;
|
|
54
|
-
export declare const scratchOrgCreate: (options: ScratchOrgCreateOptions) => Promise<ScratchOrgCreateResult>;
|
|
1
|
+
import { Duration } from '@salesforce/kit';
|
|
2
|
+
import { Org } from './org';
|
|
3
|
+
import { ScratchOrgInfo } from './scratchOrgTypes';
|
|
4
|
+
import { AuthFields, AuthInfo } from './authInfo';
|
|
5
|
+
export declare const DEFAULT_STREAM_TIMEOUT_MINUTES = 6;
|
|
6
|
+
export interface ScratchOrgCreateResult {
|
|
7
|
+
username?: string;
|
|
8
|
+
scratchOrgInfo?: ScratchOrgInfo;
|
|
9
|
+
authInfo?: AuthInfo;
|
|
10
|
+
authFields?: AuthFields;
|
|
11
|
+
warnings: string[];
|
|
12
|
+
}
|
|
13
|
+
export interface ScratchOrgCreateOptions {
|
|
14
|
+
/** the environment hub org */
|
|
15
|
+
hubOrg: Org;
|
|
16
|
+
/** The connected app consumer key. */
|
|
17
|
+
connectedAppConsumerKey?: string;
|
|
18
|
+
/** duration of the scratch org (in days) (default:1, min:1, max:30) */
|
|
19
|
+
durationDays?: number;
|
|
20
|
+
/** create the scratch org with no namespace */
|
|
21
|
+
nonamespace?: boolean;
|
|
22
|
+
/** create the scratch org with no second-generation package ancestors */
|
|
23
|
+
noancestors?: boolean;
|
|
24
|
+
/** the streaming client socket timeout (in minutes) must be an instance of the Duration utility class (default:6) */
|
|
25
|
+
wait?: Duration;
|
|
26
|
+
/** number of scratch org auth retries after scratch org is successfully signed up (default:0, min:0, max:10) */
|
|
27
|
+
retry?: number;
|
|
28
|
+
/** target server instance API version */
|
|
29
|
+
apiversion?: string;
|
|
30
|
+
/**
|
|
31
|
+
* org definition in JSON format, stringified
|
|
32
|
+
*
|
|
33
|
+
* @deprecated use orgConfig
|
|
34
|
+
*/
|
|
35
|
+
definitionjson?: string;
|
|
36
|
+
/**
|
|
37
|
+
* path to an org definition file
|
|
38
|
+
*
|
|
39
|
+
* @deprecated use orgConfig
|
|
40
|
+
* */
|
|
41
|
+
definitionfile?: string;
|
|
42
|
+
/** overrides definitionjson */
|
|
43
|
+
orgConfig?: Record<string, unknown>;
|
|
44
|
+
/** OAuth client secret of personal connected app */
|
|
45
|
+
clientSecret?: string;
|
|
46
|
+
/** alias to set for the created org */
|
|
47
|
+
alias?: string;
|
|
48
|
+
/** after complete, set the org as the default */
|
|
49
|
+
setDefault?: boolean;
|
|
50
|
+
/** if false, do not use source tracking for this scratch org */
|
|
51
|
+
tracksSource?: boolean;
|
|
52
|
+
}
|
|
53
|
+
export declare const scratchOrgResume: (jobId: string) => Promise<ScratchOrgCreateResult>;
|
|
54
|
+
export declare const scratchOrgCreate: (options: ScratchOrgCreateOptions) => Promise<ScratchOrgCreateResult>;
|