@salesforce/core 8.23.5-dev.0 → 8.23.5-qaext.0

package/lib/schema/validator.js

@@ -40,6 +40,8 @@ const fs_1 = require("../fs/fs");
 const sfError_1 = require("../sfError");
 /**
  * Loads a JSON schema and performs validations against JSON objects.
+ *
+ * @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.
  */
 class SchemaValidator {
     schemaPath;
@@ -59,6 +61,8 @@ class SchemaValidator {
     }
     /**
      * Loads a JSON schema from the `schemaPath` parameter provided at instantiation.
+     *
+     * @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.
      */
     async load() {
         if (!this.schema) {
@@ -69,6 +73,8 @@ class SchemaValidator {
     }
     /**
      * Loads a JSON schema from the `schemaPath` parameter provided at instantiation.
+     *
+     * @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.
      */
     loadSync() {
         if (!this.schema) {
@@ -86,6 +92,7 @@ class SchemaValidator {
      *
      * @param json A JSON value to validate against this instance's target schema.
      * @returns The validated JSON data.
+     * @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.
      */
     // eslint-disable-next-line @typescript-eslint/require-await
     async validate(json) {
@@ -100,6 +107,7 @@ class SchemaValidator {
      *
      * @param json A JSON value to validate against this instance's target schema.
      * @returns The validated JSON data.
+     * @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.
      */
     validateSync(json) {
         const schema = this.loadSync();

package/lib/sfProject.d.ts

@@ -1,5 +1,7 @@
 import { Dictionary, JsonMap, Nullable, Optional } from '@salesforce/ts-types';
-import { PackageDir, ProjectJson as ProjectJsonSchema, PackagePackageDir, BundleEntry } from '@salesforce/schemas';
+import { PackageDir, PackagePackageDir } from './schema/sfdx-project/packageDir';
+import { BundleEntry } from './schema/sfdx-project/bundleEntry';
+import { type ProjectJson as ProjectJsonType } from './schema/sfdx-project/sfdxProjectJson';
 import { ConfigFile } from './config/configFile';
 import { ConfigContents } from './config/configStackTypes';
 type NameAndFullPath = {
@@ -14,8 +16,7 @@ type NameAndFullPath = {
 };
 export type NamedPackagingDir = PackagePackageDir & NameAndFullPath;
 export type NamedPackageDir = PackageDir & NameAndFullPath;
-export type { BundleEntry };
-export type ProjectJson = ConfigContents & ProjectJsonSchema;
+export type ProjectJson = ConfigContents & ProjectJsonType;
 /**
  * The sfdx-project.json config object. This file determines if a folder is a valid sfdx project.
  *
@@ -56,7 +57,7 @@ export declare class SfProjectJson extends ConfigFile<ConfigFile.Options, Projec
      * Validates sfdx-project.json against the schema.
      *
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
-     * A warning is logged by default when the file is invalid.
+     * A warning is emitted by default when the file is invalid.
      *
      * ***See*** [sfdx-project.schema.json] ((https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
@@ -70,7 +71,7 @@ export declare class SfProjectJson extends ConfigFile<ConfigFile.Options, Projec
      * Validates sfdx-project.json against the schema.
      *
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
-     * A warning is logged by default when the file is invalid.
+     * A warning is emitted by default when the file is invalid.
      *
      * ***See*** [sfdx-project.schema.json] ((https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
@@ -400,3 +401,4 @@ export declare class SfProject {
 export declare const isPackagingDirectory: (packageDir: PackageDir) => packageDir is PackagePackageDir;
 /** differentiate between the Base PackageDir (path, maybe default) and the Packaging version (package and maybe a LOT of other fields) by whether is has the `package` property */
 export declare const isNamedPackagingDirectory: (packageDir: NamedPackageDir) => packageDir is NamedPackagingDir;
+export {};

package/lib/sfProject.js

@@ -10,15 +10,16 @@ exports.isNamedPackagingDirectory = exports.isPackagingDirectory = exports.SfPro
 const node_path_1 = require("node:path");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
+const sfdxProjectJson_1 = require("./schema/sfdx-project/sfdxProjectJson");
 const fs_1 = require("./fs/fs");
 const sfdcUrl_1 = require("./util/sfdcUrl");
 const configAggregator_1 = require("./config/configAggregator");
 const configFile_1 = require("./config/configFile");
-const validator_1 = require("./schema/validator");
 const internal_1 = require("./util/internal");
 const sfError_1 = require("./sfError");
 const messages_1 = require("./messages");
 const findUppercaseKeys_1 = require("./util/findUppercaseKeys");
+const lifecycleEvents_1 = require("./lifecycleEvents");
 ;
 const messages = new messages_1.Messages('@salesforce/core', 'config', new Map([["unknownConfigKey", "Unknown config name: %s."], ["deprecatedConfigKey", "Deprecated config name: %s. Please use %s instead."], ["invalidWrite", "The writeSync method is not allowed on SfdxConfig. Use the async write method instead."], ["invalidConfigValue", "Invalid config value: %s."], ["invalidInstanceUrl", "Specify a valid Salesforce instance URL."], ["invalidApiVersion", "Specify a valid Salesforce API version, for example, 42.0."], ["invalidCustomOrgMetadataTemplates", "Specify a valid repository URL or directory for the custom org metadata templates."], ["invalidIsvDebuggerSid", "Specify a valid Debugger SID."], ["invalidIsvDebuggerUrl", "Specify a valid Debugger URL."], ["invalidNumberConfigValue", "Specify a valid positive integer, for example, 150000."], ["invalidBooleanConfigValue", "The config value can only be set to true or false."], ["invalidProjectWorkspace", "%s does not contain a valid Salesforce DX project."], ["schemaValidationError", "The config file \"%s\" is not schema valid.\nDue to: %s"], ["schemaValidationError.actions", ["Fix the invalid entries at %s."]], ["missingDefaultPath", "In sfdx-project.json, be sure to specify which package directory (path) is the default. Example: `[{ \"path\": \"packageDirectory1\", \"default\": true }, { \"path\": \"packageDirectory2\" }]`"], ["missingPackageDirectory", "The path \"%s\", specified in sfdx-project.json, does not exist. Be sure this directory is included in your project root."], ["invalidPackageDirectory", "The path \"%s\", specified in sfdx-project.json, must be indicated as a relative path to the project root."], ["multipleDefaultPaths", "In sfdx-project.json, indicate only one package directory (path) as the default."], ["singleNonDefaultPackage", "The sfdx-project.json file must include one, and only one, default package directory (path). Because your sfdx-project.json file contains only one package directory, it must be the default. Remove the `\"default\": false` key and try again."], ["target-org", "Username or alias of the org that all commands run against by default. (sf only)"], ["target-dev-hub", "Username or alias of your default Dev Hub org. (sf only)"], ["defaultUsername", "Username or alias of the org that all commands run against by default. (sfdx only)"], ["defaultDevHubUsername", "Username or alias of your default Dev Hub org. (sfdx only)"], ["isvDebuggerSid", "ISV debugger SID (sfdx only)"], ["isvDebuggerUrl", "ISV debugger URL (sfdx only)"], ["org-isv-debugger-sid", "ISV debugger SID."], ["org-isv-debugger-url", "ISV debugger URL."], ["apiVersion", "API version of your project. Default: API version of your Dev Hub org. (sfdx only)"], ["org-api-version", "API version of your project. Default: API version of your Dev Hub org."], ["disableTelemetry", "Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)"], ["disable-telemetry", "Disables the collection of usage and user environment information, etc. Default: false."], ["maxQueryLimit", "Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)"], ["org-max-query-limit", "Maximum number of Salesforce records returned by a CLI command. Default: 10,000."], ["restDeploy", "Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)"], ["instanceUrl", "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)"], ["org-instance-url", "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com."], ["customOrgMetadataTemplates", "A valid repository URL or directory for the custom org metadata templates."], ["org-custom-metadata-templates", "A valid repository URL or directory for the custom org metadata templates."], ["org-capitalize-record-types", "Whether record types are capitalized on scratch org creation."], ["invalidId", "The given id %s is not a valid 15 or 18 character Salesforce ID."]]));
 /**
@@ -87,7 +88,7 @@ class SfProjectJson extends configFile_1.ConfigFile {
      * Validates sfdx-project.json against the schema.
      *
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
-     * A warning is logged by default when the file is invalid.
+     * A warning is emitted by default when the file is invalid.
      *
      * ***See*** [sfdx-project.schema.json] ((https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
@@ -96,19 +97,16 @@ class SfProjectJson extends configFile_1.ConfigFile {
             // read calls back into this method after necessarily setting this.hasRead=true
             await this.read();
         }
-        try {
-            const projectJsonSchemaPath = require.resolve('@salesforce/schemas/sfdx-project.schema.json');
-            const validator = new validator_1.SchemaValidator(this.logger, projectJsonSchemaPath);
-            await validator.validate(this.getContents());
-        }
-        catch (err) {
-            const error = err;
+        const result = sfdxProjectJson_1.ProjectJsonSchema.safeParse(this.getContents());
+        if (!result.success) {
+            const errorMessages = result.error.issues.map((err) => `${err.path.join('.')}: ${err.message}`).join('\n');
+            const fullMessage = messages.getMessage('schemaValidationError', [this.getPath(), errorMessages]);
             // Don't throw errors if the global isn't valid, but still warn the user.
             if (kit_1.env.getBoolean('SFDX_PROJECT_JSON_VALIDATION', false) && !this.options.isGlobal) {
-                throw messages.createError('schemaValidationError', [this.getPath(), error.message], [this.getPath()], error);
+                throw messages.createError('schemaValidationError', [this.getPath(), errorMessages], [this.getPath()]);
             }
             else {
-                this.logger.warn(messages.getMessage('schemaValidationError', [this.getPath(), error.message]));
+                await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(fullMessage);
             }
         }
     }
@@ -124,7 +122,7 @@ class SfProjectJson extends configFile_1.ConfigFile {
      * Validates sfdx-project.json against the schema.
      *
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
-     * A warning is logged by default when the file is invalid.
+     * A warning is emitted by default when the file is invalid.
      *
      * ***See*** [sfdx-project.schema.json] ((https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
@@ -133,19 +131,17 @@ class SfProjectJson extends configFile_1.ConfigFile {
             // read calls back into this method after necessarily setting this.hasRead=true
             this.readSync();
         }
-        try {
-            const projectJsonSchemaPath = require.resolve('@salesforce/schemas/sfdx-project.schema.json');
-            const validator = new validator_1.SchemaValidator(this.logger, projectJsonSchemaPath);
-            validator.validateSync(this.getContents());
-        }
-        catch (err) {
-            const error = err;
+        const result = sfdxProjectJson_1.ProjectJsonSchema.safeParse(this.getContents());
+        if (!result.success) {
+            const errorMessages = result.error.issues.map((err) => `${err.path.join('.')}: ${err.message}`).join('\n');
+            const fullMessage = messages.getMessage('schemaValidationError', [this.getPath(), errorMessages]);
             // Don't throw errors if the global isn't valid, but still warn the user.
             if (kit_1.env.getBoolean('SFDX_PROJECT_JSON_VALIDATION', false) && !this.options.isGlobal) {
-                throw messages.createError('schemaValidationError', [this.getPath(), error.message], [this.getPath()], error);
+                throw messages.createError('schemaValidationError', [this.getPath(), errorMessages], [this.getPath()]);
             }
             else {
-                this.logger.warn(messages.getMessage('schemaValidationError', [this.getPath(), error.message]));
+                // For sync method, we can't await emitWarning, so we use void to fire and forget
+                void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(fullMessage);
             }
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "8.23.5-dev.0",
+  "version": "8.23.5-qaext.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
@@ -22,10 +22,13 @@
     "./project": "./lib/sfProject.js",
     "./sfError": "./lib/sfError.js",
     "./stateAggregator": "./lib/stateAggregator/stateAggregator.js",
-    "./testSetup": "./lib/testSetup.js"
+    "./testSetup": "./lib/testSetup.js",
+    "./sfdx-project.schema.json": "./lib/sfdx-project.schema.json",
+    "./project-scratch-def.schema.json": "./lib/project-scratch-def.schema.json"
   },
   "scripts": {
     "build": "wireit",
+    "bundle-check": "wireit",
     "clean": "sf-clean",
     "clean-all": "sf-clean all",
     "compile": "wireit",
@@ -37,9 +40,11 @@
     "prepack": "sf-prepack",
     "prepare": "sf-install",
     "test": "wireit",
-    "test:nuts": "mocha \"test/**/*.nut.ts\" --timeout 500000",
+    "test:nuts": "wireit",
     "test:only": "wireit",
-    "test:perf": "ts-node test/perf/logger/main.test.ts"
+    "test:perf": "ts-node test/perf/logger/main.test.ts",
+    "update:features": "ts-node scripts/schemas/update-features.ts",
+    "update:settings": "ts-node scripts/schemas/update-settings.ts"
   },
   "keywords": [
     "force",
@@ -57,7 +62,6 @@
   "dependencies": {
     "@jsforce/jsforce-node": "^3.10.8",
     "@salesforce/kit": "^3.2.4",
-    "@salesforce/schemas": "^1.10.3",
     "@salesforce/ts-types": "^2.0.12",
     "ajv": "^8.17.1",
     "change-case": "^4.1.2",
@@ -73,7 +77,8 @@
     "pino-pretty": "^11.3.0",
     "proper-lockfile": "^4.1.2",
     "semver": "^7.7.3",
-    "ts-retry-promise": "^0.8.1"
+    "ts-retry-promise": "^0.8.1",
+    "zod": "^4.1.12"
   },
   "devDependencies": {
     "@salesforce/dev-scripts": "^10.1.1",
@@ -172,6 +177,19 @@
         "link-check"
       ]
     },
+    "test:nuts": {
+      "command": "mocha \"test/**/*.nut.ts\" --timeout 500000",
+      "dependencies": [
+        "compile"
+      ],
+      "files": [
+        "test/nut/**/*",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*"
+      ],
+      "output": []
+    },
     "bundle-check": {
       "command": "node scripts/build.mjs",
       "dependencies": [
@@ -197,6 +215,34 @@
     },
     "compile-typedoc": {
       "command": "tsc -p typedocExamples"
+    },
+    "build:schema:project": {
+      "command": "ts-node scripts/schemas/build-schema-project.ts",
+      "dependencies": [
+        "compile"
+      ],
+      "files": [
+        "src/schema/sfdx-project/**/*.ts",
+        "scripts/schemas/build-schema-project.ts",
+        "scripts/schemas/consts.ts"
+      ],
+      "output": [
+        "lib/sfdx-project.schema.json"
+      ]
+    },
+    "build:schema:scratch": {
+      "command": "ts-node scripts/schemas/build-schema-scratch.ts",
+      "dependencies": [
+        "compile"
+      ],
+      "files": [
+        "src/schema/project-scratch-def/**/*.ts",
+        "scripts/schemas/build-schema-scratch.ts",
+        "scripts/schemas/consts.ts"
+      ],
+      "output": [
+        "lib/project-scratch-def.schema.json"
+      ]
     }
   }
 }