fix: sfProject types matches schemas repo

src/org/scratchOrgInfoGenerator.ts

@@ -7,7 +7,7 @@
 import { promises as fs } from 'node:fs';
 import { parseJson } from '@salesforce/kit';
 import { ensureString } from '@salesforce/ts-types';
-import { SfProjectJson } from '../sfProject';
+import { SfProjectJson, isPackagingDirectory } from '../sfProject';
 import { WebOAuthServer } from '../webOAuthServer';
 import { Messages } from '../messages';
 import { SfError } from '../sfError';
@@ -90,6 +90,7 @@ export const getAncestorIds = async (
     throw new SfError(messages.getMessage('Package2AncestorsIdsKeyNotSupportedError'), 'DeprecationError');
   }
   const packagesWithAncestors = (await projectJson.getPackageDirectories())
+    .filter(isPackagingDirectory)
     // check that the package has any ancestor types (id or version)
     .filter((packageDir) => packageDir.ancestorId ?? packageDir.ancestorVersion);
   if (packagesWithAncestors.length === 0) {

src/sfProject.ts

@@ -8,6 +8,12 @@ import { basename, dirname, isAbsolute, normalize, resolve, sep } from 'node:pat
 import * as fs from 'node:fs';
 import { defaults, env } from '@salesforce/kit';
 import { Dictionary, ensure, JsonMap, Nullable, Optional } from '@salesforce/ts-types';
+import {
+  PackageDir as PackageDirSchema,
+  PackageDirDependency as PackageDirDependencySchema,
+  ProjectJson as ProjectJsonSchema,
+  PackagePackageDir,
+} from '@salesforce/schemas';
 import { SfdcUrl } from './util/sfdcUrl';
 import { ConfigAggregator } from './config/configAggregator';
 import { ConfigFile } from './config/configFile';
@@ -25,38 +31,9 @@ const messages = Messages.loadMessages('@salesforce/core', 'config');
 
 const coreMessages = Messages.loadMessages('@salesforce/core', 'core');
 
-export type PackageDirDependency = {
-  [k: string]: unknown;
-  package: string;
-  versionNumber?: string;
-};
-
-export type PackageDir = {
-  ancestorId?: string;
-  ancestorVersion?: string;
-  default?: boolean;
-  definitionFile?: string;
-  dependencies?: PackageDirDependency[];
-  includeProfileUserLicenses?: boolean;
-  package?: string;
-  packageMetadataAccess?: {
-    permissionSets: string | string[];
-    permissionSetLicenses: string | string[];
-  };
-  path: string;
-  postInstallScript?: string;
-  postInstallUrl?: string;
-  releaseNotesUrl?: string;
-  scopeProfiles?: boolean;
-  uninstallScript?: string;
-  versionDescription?: string;
-  versionName?: string;
-  versionNumber?: string;
-  unpackagedMetadata?: { path: string };
-  seedMetadata?: { path: string };
-};
+export type PackageDirDependency = PackageDirDependencySchema;
 
-export type NamedPackageDir = PackageDir & {
+type NamedDirAdditions = {
   /**
    * The [normalized](https://nodejs.org/api/path.html#path_path_normalize_path) path used as the package name.
    */
@@ -67,16 +44,11 @@ export type NamedPackageDir = PackageDir & {
   fullPath: string;
 };
 
-export type ProjectJson = ConfigContents & {
-  packageDirectories: PackageDir[];
-  namespace?: string;
-  sourceApiVersion?: string;
-  sfdcLoginUrl?: string;
-  signupTargetLoginUrl?: string;
-  oauthLocalPort?: number;
-  plugins?: { [k: string]: unknown };
-  packageAliases?: { [k: string]: string };
-};
+export type PackageDir = PackageDirSchema;
+export type NamedPackagingDir = PackagePackageDir & NamedDirAdditions;
+export type NamedPackageDir = PackageDir & NamedDirAdditions;
+
+export type ProjectJson = ConfigContents & ProjectJsonSchema;
 
 /**
  * The sfdx-project.json config object. This file determines if a folder is a valid sfdx project.
@@ -338,18 +310,8 @@ export class SfProjectJson extends ConfigFile<ConfigFile.Options, ProjectJson> {
    * @param packageDir
    */
   public addPackageDirectory(packageDir: NamedPackageDir): void {
-    // there is no notion of uniqueness in package directory entries
-    // so an attempt of matching an existing entry is a bit convoluted
-    // an entry w/o a package or id is considered a directory entry for which a package has yet to be created
-    // so first attempt is to find a matching dir entry that where path is the same and id and package are not present
-    // if that fails, then find a matching dir entry package is present and is same as the new entry
-    const dirIndex = this.getContents().packageDirectories.findIndex((pd) => {
-      const withId = pd as NamedPackageDir & { id: string };
-      return (
-        (withId.path === packageDir.path && !withId.id && !withId.package) ||
-        (!!packageDir.package && packageDir.package === withId.package)
-      );
-    });
+    const dirIndex = this.getContents().packageDirectories.findIndex(findPackageDir(packageDir));
+
     // merge new package dir with existing entry, if present
     const packageDirEntry: PackageDir = Object.assign(
       {},
@@ -367,6 +329,7 @@ export class SfProjectJson extends ConfigFile<ConfigFile.Options, ProjectJson> {
     this.set('packageDirectories', modifiedPackagesDirs);
   }
 
+  // keep it because testSetup stubs it!
   // eslint-disable-next-line class-methods-use-this
   private doesPackageExist(packagePath: string): boolean {
     return fs.existsSync(packagePath);
@@ -600,7 +563,8 @@ export class SfProject {
    */
   public getPackageNameFromPath(path: string): Optional<string> {
     const packageDir = this.getPackageFromPath(path);
-    return packageDir ? packageDir.package ?? packageDir.path : undefined;
+    if (!packageDir) return undefined;
+    return isNamedPackagingDirectory(packageDir) ? packageDir.package : packageDir.path;
   }
 
   /**
@@ -760,3 +724,22 @@ export class SfProject {
       .map(([key]) => key);
   }
 }
+
+/** differentiate between the Base PackageDir (path, maybe default) and the Packaging version (path) by whether is has the `package` property */
+export const isPackagingDirectory = (packageDir: PackageDir): packageDir is PackagePackageDir =>
+  'package' in packageDir && typeof packageDir.package === 'string';
+export const isNamedPackagingDirectory = (packageDir: NamedPackageDir): packageDir is NamedPackagingDir =>
+  'package' in packageDir && typeof packageDir.package === 'string';
+
+/**
+ * there is no notion of uniqueness in package directory entries
+ * so an attempt of matching an existing entry is a bit convoluted
+ */
+const findPackageDir =
+  (target: NamedPackageDir) =>
+  (potentialMatch: PackageDir): boolean =>
+    // an entry w/o a package or id is considered a directory entry for which a package has yet to be created
+    //  find a matching dir entry that where path is the same and id and package are not present
+    (potentialMatch.path === target.path && !('id' in potentialMatch) && !isPackagingDirectory(potentialMatch)) ||
+    // if that fails, then find a matching dir entry package is present and is same as the new entry
+    (isPackagingDirectory(target) && isPackagingDirectory(potentialMatch) && target.package === potentialMatch.package);