@salesforce/core 8.23.7 → 8.24.0

package/README.md

@@ -3,6 +3,7 @@
 - [Description](#description)
 - [Usage](#usage)
   - [Contributing](#contributing)
+- [JSON Schemas](#json-schemas)
 - [Using TestSetup](#using-testsetup)
 - [Message Transformer](#message-transformer)
 
@@ -22,6 +23,32 @@ If you're interested in contributing, take a look at the [CONTRIBUTING](CONTRIBU
 
 Report all issues to the [issues only repository](https://github.com/forcedotcom/cli/issues).
 
+## JSON Schemas
+
+This library provides JSON schemas for `sfdx-project.json` and scratch org definition files. These schemas are generated from Zod schemas that are also exported for runtime validation.
+
+### Importing JSON Schemas
+
+```javascript
+// Import the JSON schema files directly
+import sfdxProjectSchema from '@salesforce/core/sfdx-project.schema.json';
+import scratchDefSchema from '@salesforce/core/project-scratch-def.schema.json';
+```
+
+### Using Zod Schemas for Validation
+
+`.parse` validates and the result is TS-typed. See zod docs for all the parsing options.
+
+```typescript
+import { ProjectJsonSchema, ScratchOrgDefSchema } from '@salesforce/core';
+
+// Validate and parse sfdx-project.json contents (throws on invalid)
+const projectJson = ProjectJsonSchema.parse(projectJsonContents);
+
+// Validate and parse scratch org definition
+const scratchDef = ScratchOrgDefSchema.parse(scratchDefContents);
+```
+
 # Using TestSetup
 
 The Salesforce DX Core Library provides a unit testing utility to help with mocking and sand-boxing core components. This feature allows unit tests to execute without needing to make API calls to salesforce.com.

package/lib/index.d.ts

@@ -24,7 +24,10 @@ export { Fields, FieldValue, LoggerLevel, LoggerLevelValue, LogLine, LoggerOptio
 export { Messages, StructuredMessage } from './messages';
 export { Org, SandboxProcessObject, StatusEvent, SandboxInfo, SandboxEvents, SandboxUserAuthResponse, SandboxUserAuthRequest, SandboxRequest, ResumeSandboxRequest, OrgTypes, ResultEvent, ScratchOrgRequest, } from './org/org';
 export { OrgConfigProperties, ORG_CONFIG_ALLOWED_PROPERTIES } from './org/orgConfigProperties';
-export { NamedPackageDir, SfProject, SfProjectJson } from './sfProject';
+export { NamedPackageDir, SfProject, SfProjectJson, isPackagingDirectory, isNamedPackagingDirectory, } from './sfProject';
+/**
+ * @deprecated For sfdx-project.json and scratch org definitions, use the exported zod schemas (ProjectJsonSchema, ScratchOrgDefSchema) from '@salesforce/core'. For custom schemas, use a schema validator library like zod directly.
+ */
 export { SchemaValidator } from './schema/validator';
 export { SfError } from './sfError';
 export { PollingClient } from './status/pollingClient';
@@ -35,6 +38,8 @@ export { PermissionSetAssignment, PermissionSetAssignmentFields } from './org/pe
 export { lockInit } from './util/fileLocking';
 export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate, scratchOrgResume, } from './org/scratchOrgCreate';
 export { ScratchOrgInfo } from './org/scratchOrgTypes';
+export { ProjectJson, ProjectJsonSchema } from './schema/sfdx-project/sfdxProjectJson';
+export { ScratchOrgDef, ScratchOrgDefSchema } from './schema/project-scratch-def/scratchOrgDef';
 export { ScratchOrgLifecycleEvent, scratchOrgLifecycleEventName, scratchOrgLifecycleStages, } from './org/scratchOrgLifecycleEvents';
 export { ScratchOrgCache } from './org/scratchOrgCache';
 export { default as ScratchOrgSettingsGenerator } from './org/scratchOrgSettingsGenerator';

package/lib/index.js

@@ -23,8 +23,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.scratchOrgResume = exports.scratchOrgCreate = exports.lockInit = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfError = exports.SchemaValidator = exports.SfProjectJson = exports.SfProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = exports.OrgTypes = exports.SandboxEvents = exports.Org = exports.Messages = exports.Logger = exports.LoggerLevel = exports.generateApiName = exports.getJwtAudienceUrl = exports.SfdcUrl = exports.WebOAuthServer = exports.Lifecycle = exports.Global = exports.Mode = exports.SFDX_HTTP_HEADERS = exports.Connection = exports.AuthRemover = exports.AuthInfo = exports.ConfigAggregator = exports.SandboxRequestCache = exports.SF_ALLOWED_PROPERTIES = exports.SFDX_ALLOWED_PROPERTIES = exports.SfConfigProperties = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.StateAggregator = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.TTLConfig = exports.ConfigFile = void 0;
-exports.fs = exports.ScratchOrgSettingsGenerator = exports.ScratchOrgCache = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = void 0;
+exports.lockInit = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfError = exports.SchemaValidator = exports.isNamedPackagingDirectory = exports.isPackagingDirectory = exports.SfProjectJson = exports.SfProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = exports.OrgTypes = exports.SandboxEvents = exports.Org = exports.Messages = exports.Logger = exports.LoggerLevel = exports.generateApiName = exports.getJwtAudienceUrl = exports.SfdcUrl = exports.WebOAuthServer = exports.Lifecycle = exports.Global = exports.Mode = exports.SFDX_HTTP_HEADERS = exports.Connection = exports.AuthRemover = exports.AuthInfo = exports.ConfigAggregator = exports.SandboxRequestCache = exports.SF_ALLOWED_PROPERTIES = exports.SFDX_ALLOWED_PROPERTIES = exports.SfConfigProperties = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.StateAggregator = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.TTLConfig = exports.ConfigFile = void 0;
+exports.fs = exports.ScratchOrgSettingsGenerator = exports.ScratchOrgCache = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = exports.ScratchOrgDefSchema = exports.ProjectJsonSchema = exports.scratchOrgResume = exports.scratchOrgCreate = void 0;
 const messages_1 = require("./messages");
 ;
 var configFile_1 = require("./config/configFile");
@@ -87,6 +87,11 @@ Object.defineProperty(exports, "ORG_CONFIG_ALLOWED_PROPERTIES", { enumerable: tr
 var sfProject_1 = require("./sfProject");
 Object.defineProperty(exports, "SfProject", { enumerable: true, get: function () { return sfProject_1.SfProject; } });
 Object.defineProperty(exports, "SfProjectJson", { enumerable: true, get: function () { return sfProject_1.SfProjectJson; } });
+Object.defineProperty(exports, "isPackagingDirectory", { enumerable: true, get: function () { return sfProject_1.isPackagingDirectory; } });
+Object.defineProperty(exports, "isNamedPackagingDirectory", { enumerable: true, get: function () { return sfProject_1.isNamedPackagingDirectory; } });
+/**
+ * @deprecated For sfdx-project.json and scratch org definitions, use the exported zod schemas (ProjectJsonSchema, ScratchOrgDefSchema) from '@salesforce/core'. For custom schemas, use a schema validator library like zod directly.
+ */
 var validator_1 = require("./schema/validator");
 Object.defineProperty(exports, "SchemaValidator", { enumerable: true, get: function () { return validator_1.SchemaValidator; } });
 var sfError_1 = require("./sfError");
@@ -109,6 +114,10 @@ Object.defineProperty(exports, "lockInit", { enumerable: true, get: function ()
 var scratchOrgCreate_1 = require("./org/scratchOrgCreate");
 Object.defineProperty(exports, "scratchOrgCreate", { enumerable: true, get: function () { return scratchOrgCreate_1.scratchOrgCreate; } });
 Object.defineProperty(exports, "scratchOrgResume", { enumerable: true, get: function () { return scratchOrgCreate_1.scratchOrgResume; } });
+var sfdxProjectJson_1 = require("./schema/sfdx-project/sfdxProjectJson");
+Object.defineProperty(exports, "ProjectJsonSchema", { enumerable: true, get: function () { return sfdxProjectJson_1.ProjectJsonSchema; } });
+var scratchOrgDef_1 = require("./schema/project-scratch-def/scratchOrgDef");
+Object.defineProperty(exports, "ScratchOrgDefSchema", { enumerable: true, get: function () { return scratchOrgDef_1.ScratchOrgDefSchema; } });
 var scratchOrgLifecycleEvents_1 = require("./org/scratchOrgLifecycleEvents");
 Object.defineProperty(exports, "scratchOrgLifecycleEventName", { enumerable: true, get: function () { return scratchOrgLifecycleEvents_1.scratchOrgLifecycleEventName; } });
 Object.defineProperty(exports, "scratchOrgLifecycleStages", { enumerable: true, get: function () { return scratchOrgLifecycleEvents_1.scratchOrgLifecycleStages; } });

package/lib/org/scratchOrgInfoGenerator.js

@@ -14,6 +14,8 @@ const sfProject_1 = require("../sfProject");
 const webOAuthServer_1 = require("../webOAuthServer");
 const messages_1 = require("../messages");
 const sfError_1 = require("../sfError");
+const scratchOrgDef_1 = require("../schema/project-scratch-def/scratchOrgDef");
+const lifecycleEvents_1 = require("../lifecycleEvents");
 const scratchOrgFeatureDeprecation_1 = require("./scratchOrgFeatureDeprecation");
 const authInfo_1 = require("./authInfo");
 ;
@@ -227,7 +229,16 @@ const parseDefinitionFile = async (definitionFile) => {
         const defFileContents = (0, kit_1.parseJson)(fileData);
         // remove key '$schema' from the definition file
         delete defFileContents['$schema'];
-        return defFileContents;
+        // Validate with zod schema and emit warnings if there are issues
+        const result = scratchOrgDef_1.ScratchOrgDefSchema.safeParse(defFileContents);
+        if (!result.success) {
+            const errorMessages = result.error.issues.map((err) => `${err.path.join('.')}: ${err.message}`).join('\n');
+            await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(`Scratch org definition validation issues in ${definitionFile}:\n${errorMessages}`);
+            return defFileContents;
+        }
+        else {
+            return result.data;
+        }
     }
     catch (err) {
         const error = err;

package/lib/schema/project-scratch-def/features.d.ts

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export declare const FeaturesSchema: z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<z.ZodString[]>, z.ZodString]>>;

package/lib/schema/project-scratch-def/features.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeaturesSchema = void 0;
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const zod_1 = require("zod");
+const simpleFeaturesList_1 = require("./simpleFeaturesList");
+const patternFeaturesList_1 = require("./patternFeaturesList");
+// Set for O(1) case-insensitive lookup of simple features
+const simpleFeaturesLowerSet = new Set(simpleFeaturesList_1.simpleFeaturesList.map((f) => f.toLowerCase()));
+// Helper to create a case-insensitive feature pattern with title
+// Note: JSON Schema pattern won't include the 'i' flag, but Zod validates case-insensitively
+const featurePattern = (name) => zod_1.z
+    .string()
+    .regex(new RegExp(`^${name}:[0-9]+$`, 'i'))
+    .meta({ title: `${name}:<value>` });
+// Case-insensitive simple feature validation
+// Uses refine for runtime case-insensitivity, meta.enum for JSON Schema output
+const simpleFeatureSchema = zod_1.z
+    .string()
+    .refine((s) => simpleFeaturesLowerSet.has(s.toLowerCase()))
+    .meta({ enum: simpleFeaturesList_1.simpleFeaturesList });
+// Combined features schema
+// Features are case-insensitive per Salesforce docs:
+// https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file_config_values.htm
+exports.FeaturesSchema = zod_1.z.array(zod_1.z.union([
+    // Feature patterns - parametrized features with numeric values
+    zod_1.z.union(patternFeaturesList_1.patternFeaturesList.map(featurePattern)),
+    // Feature enum - boolean/named features
+    simpleFeatureSchema,
+]));
+//# sourceMappingURL=features.js.map

package/lib/schema/project-scratch-def/patternFeaturesList.d.ts

@@ -0,0 +1 @@
+export declare const patternFeaturesList: string[];

package/lib/schema/project-scratch-def/patternFeaturesList.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patternFeaturesList = void 0;
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+exports.patternFeaturesList = [
+    'AddCustomApps',
+    'AddCustomObjects',
+    'AddCustomRelationships',
+    'AddCustomTabs',
+    'AddDataComCRMRecordCredit',
+    'AddInsightsQueryLimit',
+    'AdditionalFieldHistory',
+    'AssetScheduling',
+    'CalloutSizeMB',
+    'ConcStreamingClients',
+    'ConsolePersistenceInterval',
+    'EducationCloud',
+    'EmpPublishRateLimit',
+    'EncryptionStatisticsInterval',
+    'EncryptionSyncInterval',
+    'FieldService',
+    'FieldServiceAppointmentAssistantUser',
+    'FieldServiceDispatcherUser',
+    'FieldServiceLastMileUser',
+    'FieldServiceMobileUser',
+    'FieldServiceSchedulingUser',
+    'FinancialServicesCommunityUser',
+    'FinancialServicesUser',
+    'GenStreamingEventsPerDay',
+    'HoursBetweenCoverageJob',
+    'LoyaltyMaxOrderLinePerHour',
+    'LoyaltyMaxProcExecPerHour',
+    'LoyaltyMaxTransactions',
+    'LoyaltyMaxTrxnJournals',
+    'LoyaltyMaximumPartners',
+    'LoyaltyMaximumPrograms',
+    'MaxActiveDPEDefs',
+    'MaxApexCodeSize',
+    'MaxCustomLabels',
+    'MaxDataSourcesPerDPE',
+    'MaxDatasetLinksPerDT',
+    'MaxDecisionTableAllowed',
+    'MaxFavoritesAllowed',
+    'MaxFieldsPerNode',
+    'MaxInputColumnsPerDT',
+    'MaxLoyaltyProcessRules',
+    'MaxNoOfLexThemesAllowed',
+    'MaxNodesPerDPE',
+    'MaxOutputColumnsPerDT',
+    'MaxSourceObjectPerDSL',
+    'MaxStreamingTopics',
+    'MaxUserNavItemsAllowed',
+    'MaxUserStreamingChannels',
+    'MaxWritebacksPerDPE',
+    'MedVisDescriptorLimit',
+    'MobileExtMaxFileSizeMB',
+    'NumPlatformEvents',
+    'PlatformConnect',
+    'PlatformEventsPerDay',
+    'StreamingEventsPerDay',
+    'SubPerStreamingChannel',
+    'SubPerStreamingTopic',
+];
+//# sourceMappingURL=patternFeaturesList.js.map

package/lib/schema/project-scratch-def/scratchOrgDef.d.ts

@@ -0,0 +1,176 @@
+import { z } from 'zod';
+/**
+ * Scratch Org Definition Configuration
+ * The scratch org definition file contains the configuration values that determine the shape of the scratch org.
+ */
+export declare const ScratchOrgDefSchema: z.ZodObject<{
+    orgName: z.ZodOptional<z.ZodString>;
+    edition: z.ZodEnum<{
+        Group: "Group";
+        Developer: "Developer";
+        Enterprise: "Enterprise";
+        "Partner Developer": "Partner Developer";
+        "Partner Enterprise": "Partner Enterprise";
+        "Partner Group": "Partner Group";
+        "Partner Professional": "Partner Professional";
+        Professional: "Professional";
+    }>;
+    country: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    adminEmail: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    hasSampleData: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    language: z.ZodOptional<z.ZodString>;
+    features: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<z.ZodString[]>, z.ZodString]>>>;
+    template: z.ZodOptional<z.ZodString>;
+    settings: z.ZodOptional<z.ZodObject<{
+        accountingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        accountInsightsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        accountIntelligenceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        accountPlanSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        accountSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        actionsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        activitiesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        addressSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        agentforceForDevelopersSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        agentPlatformSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        aIReplyRecommendationsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        analyticsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        apexSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        appAnalyticsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        appExperienceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        associationEngineSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        automatedContactsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        botSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        branchManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        businessHoursSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        campaignSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        caseSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        chatterAnswersSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        chatterEmailsMDSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        chatterSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        codeBuilderSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        collectionsDashboardSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        communitiesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        companySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        connectedAppSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        contentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        contractSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        conversationalIntelligenceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        conversationChannelDefinition: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        currencySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        customAddressFieldSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        dataDotComSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        dataImportManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        deploymentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        devHubSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        documentGenerationSetting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        dynamicFormsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        eACSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        einsteinAgentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        einsteinAISettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        einsteinGptSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        emailAdministrationSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        emailIntegrationSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        emailTemplateSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        employeeUserSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        encryptionKeySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        enhancedNotesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        entitlementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        eventSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        experienceBundleSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        externalClientAppSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        externalServicesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        fieldServiceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        filesConnectSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        fileUploadAndDownloadSecuritySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        flowSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        forecastingObjectListSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        forecastingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        highVelocitySalesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        ideasSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        identityProviderSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        iframeWhiteListUrlSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        incidentMgmtSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        industriesEinsteinFeatureSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        industriesLoyaltySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        industriesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        interestTaggingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        inventorySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        invLatePymntRiskCalcSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        invocableActionSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        ioTSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        knowledgeSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        languageSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        leadConfigSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        leadConvertSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        lightningExperienceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        liveAgentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        liveMessageSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        macroSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        mailMergeSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        mapAndLocationSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        meetingsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        mfgServiceConsoleSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        mobileSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        myDomainSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        nameSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        notificationsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        oauthOidcSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        objectHierarchyRelationship: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        objectLinkingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        omniChannelSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        opportunityInsightsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        opportunityScoreSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        opportunitySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        orderManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        orderSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        orgPreferenceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        orgSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        pardotEinsteinSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        pardotSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        partyDataModelSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        pathAssistantSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        paymentsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        picklistSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        platformEncryptionSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        platformEventSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        predictionBuilderSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        privacySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        processFlowMigration: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        productSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        quoteSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        realTimeEventSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        recordPageSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        retailExecutionSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        salesAgreementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        sandboxSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        schemaSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        searchSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        securitySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        serviceCloudVoiceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        serviceSetupAssistantSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        sharingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        siteSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        socialCustomerServiceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        socialProfileSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        sourceTrackingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        subscriptionManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        surveySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        territory2Settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        trailheadSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        trialOrgSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        userEngagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        userInterfaceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        userManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        voiceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        warrantyLifeCycleMgmtSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        workDotComSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        workforceEngagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$catchall<z.ZodUnknown>>>;
+    release: z.ZodOptional<z.ZodEnum<{
+        preview: "preview";
+        previous: "previous";
+    }>>;
+}, z.core.$catchall<z.ZodUnknown>>;
+export type ScratchOrgDef = z.infer<typeof ScratchOrgDefSchema>;

package/lib/schema/project-scratch-def/scratchOrgDef.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScratchOrgDefSchema = void 0;
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const zod_1 = require("zod");
+const features_1 = require("./features");
+const settings_1 = require("./settings");
+/**
+ * Scratch Org Definition Configuration
+ * The scratch org definition file contains the configuration values that determine the shape of the scratch org.
+ */
+exports.ScratchOrgDefSchema = zod_1.z
+    .object({
+    orgName: zod_1.z.string().optional().describe('The name of the scratch org.').meta({ title: 'Organization Name' }),
+    edition: zod_1.z
+        .enum([
+        'Developer',
+        'Enterprise',
+        'Group',
+        'Partner Developer',
+        'Partner Enterprise',
+        'Partner Group',
+        'Partner Professional',
+        'Professional',
+    ])
+        .describe('The Salesforce edition of the scratch org.'),
+    country: zod_1.z
+        .string()
+        .max(2)
+        .optional()
+        .describe("Dev Hub's country. If you want to override this value, enter the two-character, upper-case ISO-3166 country code (Alpha-2 code). You can find a full list of these codes at several sites, such as: https://www.iso.org/obp/ui/#search. This value sets the locale of the scratch org."),
+    username: zod_1.z.string().optional().describe('A user name formatted like test-unique_identifier@orgName.net.'),
+    adminEmail: zod_1.z
+        .string()
+        .optional()
+        .describe('Email address of the Dev Hub user making the scratch org creation request.')
+        .meta({ title: 'Administrator Email Address' }),
+    description: zod_1.z
+        .string()
+        .optional()
+        .describe("The description is a good way to document the scratch org's purpose. You can view or edit the description in the Dev Hub. From App Launcher, select Scratch Org Info or Active Scratch Orgs, then click the scratch org number.")
+        .meta({ title: 'Description of the Org' }),
+    hasSampleData: zod_1.z
+        .boolean()
+        .default(false)
+        .optional()
+        .describe('Valid values are true and false. False is the default, which creates an org without sample data.')
+        .meta({ title: 'Include Sample Data' }),
+    language: zod_1.z
+        .string()
+        .max(5)
+        .optional()
+        .describe('Default language for the country. To override the language set by the Dev Hub locale, see Supported Languages (https://help.salesforce.com/articleView?id=faq_getstart_what_languages_does.htm&type=5&language=en_US) for the codes to use in this field.')
+        .meta({ title: 'Default Language' }),
+    features: features_1.FeaturesSchema.optional().describe('Features to enable in the scratch org.'),
+    template: zod_1.z
+        .string()
+        .optional()
+        .describe('The template id for the scratch org shape. (Pilot)')
+        .meta({ title: 'Template ID' }),
+    settings: settings_1.SettingsSchema.optional().describe('Settings for the scratch org.'),
+    release: zod_1.z
+        .enum(['preview', 'previous'])
+        .optional()
+        .describe('Same Salesforce release as the Dev Hub org. Options are preview or previous. Can use only during Salesforce release transition periods.'),
+})
+    .catchall(zod_1.z.unknown());
+//# sourceMappingURL=scratchOrgDef.js.map