@aneuhold/core-ts-lib 2.2.9 → 2.2.11

package/lib/services/{PackageService.ts → PackageService/JsrPackageService.ts}

@@ -2,21 +2,20 @@ import { exec, spawn } from 'child_process';
 import { access, readFile, writeFile } from 'fs/promises';
 import path from 'path';
 import { promisify } from 'util';
-import { JsonWithVersionProperty } from '../types/JsonWithVersionProperty.js';
-import { PackageJson } from '../types/PackageJson.js';
-import ErrorUtils from '../utils/ErrorUtils.js';
-import { DR } from './DependencyRegistry.js';
-import DependencyService from './DependencyService.js';
-import FileSystemService from './FileSystemService/FileSystemService.js';
-import StringService from './StringService.js';
+import { JsonWithVersionProperty } from '../../types/JsonWithVersionProperty.js';
+import { PackageJson } from '../../types/PackageJson.js';
+import ErrorUtils from '../../utils/ErrorUtils.js';
+import { DR } from '../DependencyRegistry.js';
+import DependencyService from '../DependencyService.js';
+import FileSystemService from '../FileSystemService/FileSystemService.js';
+import PackageServiceUtils from './PackageServiceUtils.js';
 
 const execAsync = promisify(exec);
 
 /**
- * A service which can be used to assist in publishing or validating packages
- * for the current project.
+ * Service for handling JSR-specific package operations including validation and publishing.
  */
-export default class PackageService {
+export default class JsrPackageService {
   /**
    * Validates the current project for publishing to JSR. This will check if the
    * project has any pending changes first, then update the version of the
@@ -28,13 +27,12 @@ export default class PackageService {
    * **Warning:** This method uses simple string replacement for package names, which may have unintended effects
    * if the package name appears in unexpected places. Use with caution.
    */
-  static async validateJsrPublish(alternativePackageNames?: string[]): Promise<void> {
-    if (await FileSystemService.hasPendingChanges()) {
-      DR.logger.error('Please commit or stash your changes before publishing.');
-      process.exit(1);
-    }
+  static async validatePublish(alternativePackageNames?: string[]): Promise<void> {
+    const { packageName: originalPackageName, version: currentVersion } =
+      await PackageServiceUtils.getPackageInfo();
+
+    await PackageServiceUtils.validatePrePublishRequirements(currentVersion);
 
-    const { packageName: originalPackageName } = await PackageService.getPackageInfo();
     const packageNamesToValidate = [originalPackageName, ...(alternativePackageNames || [])];
 
     for (const packageName of packageNamesToValidate) {
@@ -43,14 +41,14 @@ export default class PackageService {
       DR.logger.info(`Validating JSR publishing for package: ${packageName}`);
 
       if (isAlternativeName) {
-        await PackageService.replacePackageName(originalPackageName, packageName);
+        await PackageServiceUtils.replacePackageName(originalPackageName, packageName);
       }
 
-      await PackageService.replaceMonorepoImportsWithNpmSpecifiers();
-      const { version: currentVersion } = await PackageService.updateJsrFromPackageJson();
-      const successfulDryRun = await PackageService.publishJsrDryRun(packageName, currentVersion);
+      await this.replaceMonorepoImportsWithNpmSpecifiers();
+      const { version } = await JsrPackageService.updateJsrFromPackageJson();
+      const successfulDryRun = await JsrPackageService.publishDryRun(packageName, version);
 
-      await PackageService.resetGitChanges();
+      await PackageServiceUtils.resetGitChanges();
 
       if (!successfulDryRun) {
         process.exit(1);
@@ -68,13 +66,13 @@ export default class PackageService {
    * **Warning:** This method uses simple string replacement for package names, which may have unintended effects
    * if the package name appears in unexpected places. Use with caution.
    */
-  static async publishToJsr(alternativePackageNames?: string[]): Promise<void> {
-    if (await FileSystemService.hasPendingChanges()) {
-      DR.logger.error('Please commit or stash your changes before publishing.');
-      process.exit(1);
-    }
+  static async publish(alternativePackageNames?: string[]): Promise<void> {
+    const { packageName: originalPackageName } = await PackageServiceUtils.getPackageInfo();
+
+    await PackageServiceUtils.validatePrePublishRequirements(
+      (await PackageServiceUtils.getPackageInfo()).version
+    );
 
-    const { packageName: originalPackageName } = await PackageService.getPackageInfo();
     const packageNamesToPublish = [originalPackageName, ...(alternativePackageNames || [])];
 
     for (const packageName of packageNamesToPublish) {
@@ -83,14 +81,14 @@ export default class PackageService {
       DR.logger.info(`Publishing to JSR for package: ${packageName}`);
 
       if (isAlternativeName) {
-        await PackageService.replacePackageName(originalPackageName, packageName);
+        await PackageServiceUtils.replacePackageName(originalPackageName, packageName);
       }
 
-      await PackageService.replaceMonorepoImportsWithNpmSpecifiers();
-      await PackageService.updateJsrFromPackageJson();
-      const result = await PackageService.publishJsr();
+      await this.replaceMonorepoImportsWithNpmSpecifiers();
+      await JsrPackageService.updateJsrFromPackageJson();
+      const result = await JsrPackageService.publishToJsr();
 
-      await PackageService.resetGitChanges();
+      await PackageServiceUtils.resetGitChanges();
 
       if (!result) {
         process.exit(1);
@@ -100,111 +98,6 @@ export default class PackageService {
     DR.logger.success('Successfully published to JSR for all package names.');
   }
 
-  /**
-   * Validates the current project for publishing to npm. This will run
-   * `npm publish --access public --dry-run` and check for version conflicts
-   * on the npm registry.
-   *
-   * @param alternativePackageNames Optional array of alternative package names to validate publishing under
-   *
-   * **Warning:** This method uses simple string replacement for package names, which may have unintended effects
-   * if the package name appears in unexpected places. Use with caution.
-   */
-  static async validateNpmPublish(alternativePackageNames?: string[]): Promise<void> {
-    if (await FileSystemService.hasPendingChanges()) {
-      DR.logger.error('Please commit or stash your changes before publishing.');
-      process.exit(1);
-    }
-
-    const { packageName: originalPackageName, version: currentVersion } =
-      await PackageService.getPackageInfo();
-    const packageNamesToValidate = [originalPackageName, ...(alternativePackageNames || [])];
-
-    for (const packageName of packageNamesToValidate) {
-      const isAlternativeName = packageName !== originalPackageName;
-
-      DR.logger.info(`Validating npm publishing for package: ${packageName}`);
-
-      if (isAlternativeName) {
-        await PackageService.replacePackageName(originalPackageName, packageName);
-      }
-
-      const successfulDryRun = await PackageService.publishNpmDryRun();
-      if (!successfulDryRun) {
-        if (isAlternativeName) {
-          await PackageService.resetGitChanges();
-        }
-        process.exit(1);
-      }
-
-      await PackageService.checkNpmVersionConflicts(packageName, currentVersion);
-
-      if (isAlternativeName) {
-        await PackageService.resetGitChanges();
-      }
-    }
-
-    DR.logger.success('Successfully validated npm publishing for all package names.');
-  }
-
-  /**
-   * Publishes the current project to npm.
-   *
-   * @param alternativePackageNames Optional array of alternative package names to publish under
-   *
-   * **Warning:** This method uses simple string replacement for package names, which may have unintended effects
-   * if the package name appears in unexpected places. Use with caution.
-   */
-  static async publishToNpm(alternativePackageNames?: string[]): Promise<void> {
-    if (await FileSystemService.hasPendingChanges()) {
-      DR.logger.error('Please commit or stash your changes before publishing.');
-      process.exit(1);
-    }
-
-    const { packageName: originalPackageName } = await PackageService.getPackageInfo();
-    const packageNamesToPublish = [originalPackageName, ...(alternativePackageNames || [])];
-
-    for (const packageName of packageNamesToPublish) {
-      const isAlternativeName = packageName !== originalPackageName;
-
-      DR.logger.info(`Publishing to npm for package: ${packageName}`);
-
-      if (isAlternativeName) {
-        await PackageService.replacePackageName(originalPackageName, packageName);
-      }
-
-      const result = await PackageService.publishNpm();
-
-      if (isAlternativeName) {
-        await PackageService.resetGitChanges();
-      }
-
-      if (!result) {
-        process.exit(1);
-      }
-    }
-
-    DR.logger.success('Successfully published to npm for all package names.');
-  }
-
-  /**
-   * Test method for string replacement functionality. This method allows testing
-   * the string replacement behavior without performing actual publishing operations.
-   *
-   * @param originalString The original string to replace
-   * @param newString The new string to replace it with
-   *
-   * **Warning:** This method uses simple string replacement, which may have unintended effects
-   * if the string appears in unexpected places. Use with caution.
-   */
-  static async testStringReplacement(originalString: string, newString: string): Promise<void> {
-    DR.logger.info(`Testing string replacement from "${originalString}" to "${newString}"`);
-
-    await PackageService.replacePackageName(originalString, newString);
-
-    DR.logger.info('Test completed - package name replacement has been applied');
-  }
-
   /**
    * Updates the jsr.json file from the package.json file and resolves wildcard
    * dependencies in package.json for JSR compatibility.
@@ -226,7 +119,7 @@ export default class PackageService {
     }
 
     try {
-      const { packageName, version } = await PackageService.getPackageInfo();
+      const { packageName, version } = await PackageServiceUtils.getPackageInfo();
       const packageJsonData = JSON.parse(await readFile(packageJsonPath, 'utf-8')) as PackageJson;
       const jsrJsonData = JSON.parse(
         await readFile(jsrJsonPath, 'utf-8')
@@ -252,51 +145,6 @@ export default class PackageService {
     }
   }
 
-  /**
-   * Resolves wildcard dependencies in package.json by replacing them with actual
-   * version constraints (e.g., "*1.2.3") for JSR compatibility. This will
-   * write the modified package.json back to disk.
-   *
-   * @param packageJsonData The package.json data to modify
-   * @param packageJsonPath The path to the package.json file
-   */
-  private static async resolveWildcardDependenciesInPackageJson(
-    packageJsonData: PackageJson,
-    packageJsonPath: string
-  ): Promise<void> {
-    try {
-      // Get all packages one directory up to resolve local wildcard dependencies
-      const childPackages = await DependencyService.getChildPackageJsons('../');
-
-      // Helper function to resolve dependencies
-      const resolveDependencies = (deps: Record<string, string> | undefined): void => {
-        if (!deps) return;
-
-        for (const [depName, depVersion] of Object.entries(deps)) {
-          if (depVersion === '*' && depName in childPackages) {
-            // Replace wildcard with "*" + actual version from the monorepo
-            deps[depName] = `*${childPackages[depName].packageJsonContents.version}`;
-          }
-        }
-      };
-
-      // Resolve each dependency type
-      resolveDependencies(packageJsonData.dependencies);
-      resolveDependencies(packageJsonData.devDependencies);
-      resolveDependencies(packageJsonData.peerDependencies);
-      resolveDependencies(packageJsonData.optionalDependencies);
-
-      // Write the updated package.json
-      await writeFile(packageJsonPath, JSON.stringify(packageJsonData, null, 2));
-
-      DR.logger.info('Resolved wildcard dependencies in package.json for JSR compatibility');
-    } catch (error) {
-      const errorString = ErrorUtils.getErrorString(error);
-      DR.logger.error(`Failed to resolve wildcard dependencies: ${errorString}`);
-      throw error;
-    }
-  }
-
   /**
    * Executes a dry run of JSR publishing. Returns true if the dry run was
    * successful, false otherwise. Also checks for existing versions on JSR
@@ -306,12 +154,12 @@ export default class PackageService {
    * @param packageName The package name from jsr.json
    * @param currentVersion The current version from package.json
    */
-  private static async publishJsrDryRun(
+  private static async publishDryRun(
     packageName: string,
     currentVersion: string
   ): Promise<boolean> {
     // Check for existing versions on JSR first
-    await this.checkJsrVersionConflicts(packageName, currentVersion);
+    await JsrPackageService.checkVersionConflicts(packageName, currentVersion);
 
     DR.logger.info('Running `jsr publish --dry-run`');
     try {
@@ -332,7 +180,7 @@ export default class PackageService {
    *
    * @returns true if the publish was successful, false otherwise.
    */
-  private static async publishJsr(): Promise<boolean> {
+  private static async publishToJsr(): Promise<boolean> {
     DR.logger.info('Running `jsr publish`');
     return new Promise((resolve) => {
       const child = spawn('jsr publish', ['--allow-dirty'], {
@@ -351,82 +199,35 @@ export default class PackageService {
   }
 
   /**
-   * Gets the package name and version from package.json.
-   *
-   * @returns An object containing the package name and version
-   */
-  private static async getPackageInfo(): Promise<{
-    packageName: string;
-    version: string;
-  }> {
-    const rootDir = process.cwd();
-    const packageJsonPath = path.join(rootDir, 'package.json');
-
-    try {
-      await access(packageJsonPath);
-    } catch {
-      throw new Error('No package.json file found in the current directory.');
-    }
-
-    try {
-      const packageJsonData = JSON.parse(await readFile(packageJsonPath, 'utf-8')) as PackageJson;
-
-      return {
-        packageName: packageJsonData.name,
-        version: packageJsonData.version
-      };
-    } catch (error) {
-      const errorString = ErrorUtils.getErrorString(error);
-      DR.logger.error(`Failed to read package.json: ${errorString}`);
-      throw error;
-    }
-  }
-
-  /**
-   * Executes a dry run of npm publishing.
-   *
-   * @returns true if the dry run was successful, false otherwise.
-   */
-  private static async publishNpmDryRun(): Promise<boolean> {
-    DR.logger.info('Running `npm publish --access public --dry-run`');
-    try {
-      await execAsync('npm publish --access public --dry-run');
-      DR.logger.info('npm dry run completed successfully.');
-    } catch (error) {
-      const errorString = ErrorUtils.getErrorString(error);
-      DR.logger.error(`npm dry run failed: ${errorString}`);
-      return false;
-    }
-    return true;
-  }
-
-  /**
-   * Checks npm registry for package information and performs version conflict checks.
+   * Checks for version conflicts on JSR by looking up the current package
+   * and comparing versions. Throws an error if the current version already
+   * exists or if a higher version is already published.
    *
-   * @param packageName The package name from package.json
+   * @param packageName The package name from jsr.json
    * @param currentVersion The current version from package.json
    */
-  private static async checkNpmVersionConflicts(
+  private static async checkVersionConflicts(
     packageName: string,
     currentVersion: string
   ): Promise<void> {
-    DR.logger.info(`Checking npm registry for existing versions of ${packageName}...`);
+    DR.logger.info(`Checking JSR for existing versions of ${packageName}...`);
 
     try {
-      const { stdout } = await execAsync(`npm view ${packageName}`);
+      const { stdout } = await execAsync(`jsr view ${packageName}`);
 
-      // Parse the npm view output to extract the latest version
+      // Parse the JSR view output to extract the latest version
       const latestVersionMatch = stdout.match(/latest:\s*([^\s|]+)/);
       if (latestVersionMatch) {
         const latestVersion = latestVersionMatch[1];
-        PackageService.checkVersionConflict(currentVersion, latestVersion, 'npm');
+
+        PackageServiceUtils.checkVersionConflict(currentVersion, latestVersion, 'JSR');
       }
     } catch (error) {
       const errorString = ErrorUtils.getErrorString(error);
 
-      // If the package doesn't exist on npm, that's fine for first publish
-      if (errorString.includes('404') || errorString.includes('not found')) {
-        DR.logger.info('Package not found on npm - this appears to be a first publish.');
+      // If the package doesn't exist on JSR, that's fine for first publish
+      if (errorString.includes('Package not found') || errorString.includes('404')) {
+        DR.logger.info('Package not found on JSR - this appears to be a first publish.');
         return;
       }
 
@@ -435,8 +236,8 @@ export default class PackageService {
         throw error;
       }
 
-      // For other npm command errors, log but don't block
-      DR.logger.warn(`Could not check npm registry: ${errorString}`);
+      // For other JSR command errors, log but don't block
+      DR.logger.warn(`Could not check JSR versions: ${errorString}`);
     }
   }
 
@@ -557,141 +358,47 @@ export default class PackageService {
   }
 
   /**
-   * Checks for version conflicts on JSR by looking up the current package
-   * and comparing versions. Throws an error if the current version already
-   * exists or if a higher version is already published.
+   * Resolves wildcard dependencies in package.json by replacing them with actual
+   * version constraints (e.g., "*1.2.3") for JSR compatibility. This will
+   * write the modified package.json back to disk.
    *
-   * @param packageName The package name from jsr.json
-   * @param currentVersion The current version from package.json
+   * @param packageJsonData The package.json data to modify
+   * @param packageJsonPath The path to the package.json file
    */
-  private static async checkJsrVersionConflicts(
-    packageName: string,
-    currentVersion: string
+  private static async resolveWildcardDependenciesInPackageJson(
+    packageJsonData: PackageJson,
+    packageJsonPath: string
   ): Promise<void> {
-    DR.logger.info(`Checking JSR for existing versions of ${packageName}...`);
-
     try {
-      const { stdout } = await execAsync(`jsr view ${packageName}`);
-
-      // Parse the JSR view output to extract the latest version
-      const latestVersionMatch = stdout.match(/latest:\s*([^\s|]+)/);
-      if (latestVersionMatch) {
-        const latestVersion = latestVersionMatch[1];
-
-        PackageService.checkVersionConflict(currentVersion, latestVersion, 'JSR');
-      }
-    } catch (error) {
-      const errorString = ErrorUtils.getErrorString(error);
-
-      // If the package doesn't exist on JSR, that's fine for first publish
-      if (errorString.includes('Package not found') || errorString.includes('404')) {
-        DR.logger.info('Package not found on JSR - this appears to be a first publish.');
-        return;
-      }
-
-      // Re-throw version conflict errors
-      if (errorString.includes('already exists') || errorString.includes('is lower than')) {
-        throw error;
-      }
-
-      // For other JSR command errors, log but don't block
-      DR.logger.warn(`Could not check JSR versions: ${errorString}`);
-    }
-  }
-
-  /**
-   * Common logic for checking version conflicts between current and latest versions.
-   *
-   * @param currentVersion The current version from package.json
-   * @param latestVersion The latest published version
-   * @param registryName The name of the registry (for error messages)
-   */
-  private static checkVersionConflict(
-    currentVersion: string,
-    latestVersion: string,
-    registryName: string
-  ): void {
-    DR.logger.info(
-      `Current version: ${currentVersion}, Latest on ${registryName}: ${latestVersion}`
-    );
-
-    // Compare versions using semver-like comparison
-    const comparison = StringService.compareSemanticVersions(currentVersion, latestVersion);
-
-    if (comparison === 0) {
-      throw new Error(
-        `Version ${currentVersion} already exists on ${registryName}. Please bump the version before publishing.`
-      );
-    } else if (comparison < 0) {
-      throw new Error(
-        `Current version ${currentVersion} is lower than the latest published version ${latestVersion} on ${registryName}. Please bump the version.`
-      );
-    }
-
-    DR.logger.info('Version check passed - ready to publish.');
-  }
+      // Get all packages one directory up to resolve local wildcard dependencies
+      const childPackages = await DependencyService.getChildPackageJsons('../');
 
-  /**
-   * Replaces the package name in all files in the root directory, but no child directories,
-   * with a new name.
-   *
-   * @param originalPackageName The original package name to replace
-   * @param newPackageName The new package name to use
-   */
-  private static async replacePackageName(
-    originalPackageName: string,
-    newPackageName: string
-  ): Promise<void> {
-    DR.logger.info(`Replacing package name from "${originalPackageName}" to "${newPackageName}"`);
+      // Helper function to resolve dependencies
+      const resolveDependencies = (deps: Record<string, string> | undefined): void => {
+        if (!deps) return;
 
-    const rootDir = process.cwd();
+        for (const [depName, depVersion] of Object.entries(deps)) {
+          if (depVersion === '*' && depName in childPackages) {
+            // Replace wildcard with "*" + actual version from the monorepo
+            deps[depName] = `*${childPackages[depName].packageJsonContents.version}`;
+          }
+        }
+      };
 
-    // Replace in all files in the root directory
-    await FileSystemService.replaceInFiles({
-      searchString: originalPackageName,
-      replaceString: newPackageName,
-      rootPath: rootDir,
-      includePatterns: ['*'],
-      excludePatterns: []
-    });
+      // Resolve each dependency type
+      resolveDependencies(packageJsonData.dependencies);
+      resolveDependencies(packageJsonData.devDependencies);
+      resolveDependencies(packageJsonData.peerDependencies);
+      resolveDependencies(packageJsonData.optionalDependencies);
 
-    DR.logger.info(`Successfully replaced package name in configuration files`);
-  }
+      // Write the updated package.json
+      await writeFile(packageJsonPath, JSON.stringify(packageJsonData, null, 2));
 
-  /**
-   * Performs a git reset to discard all changes in the working directory.
-   * This is used between alternative package name operations.
-   */
-  private static async resetGitChanges(): Promise<void> {
-    DR.logger.info('Resetting git changes');
-    try {
-      await execAsync('git reset --hard HEAD');
+      DR.logger.info('Resolved wildcard dependencies in package.json for JSR compatibility');
     } catch (error) {
-      DR.logger.error(`Failed to reset git changes: ${ErrorUtils.getErrorString(error)}`);
+      const errorString = ErrorUtils.getErrorString(error);
+      DR.logger.error(`Failed to resolve wildcard dependencies: ${errorString}`);
       throw error;
     }
   }
-
-  /**
-   * Publishes the current project to npm.
-   *
-   * @returns true if the publish was successful, false otherwise.
-   */
-  private static async publishNpm(): Promise<boolean> {
-    DR.logger.info('Running `npm publish --access public`');
-    return new Promise((resolve) => {
-      const child = spawn('npm publish', ['--access', 'public'], {
-        stdio: 'inherit',
-        shell: true
-      });
-
-      child.on('exit', (code) => {
-        if (code === 0) {
-          resolve(true);
-        } else {
-          resolve(false);
-        }
-      });
-    });
-  }
 }

package/lib/services/PackageService/NpmPackageService.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Service for handling NPM-specific package operations including validation and publishing.
+ */
+export default class NpmPackageService {
+    /**
+     * Validates the current project for publishing to npm. This will run
+     * `npm publish --access public --dry-run` and check for version conflicts
+     * on the npm registry.
+     *
+     * @param alternativePackageNames Optional array of alternative package names to validate publishing under
+     *
+     * **Warning:** This method uses simple string replacement for package names, which may have unintended effects
+     * if the package name appears in unexpected places. Use with caution.
+     */
+    static validatePublish(alternativePackageNames?: string[]): Promise<void>;
+    /**
+     * Publishes the current project to npm.
+     *
+     * @param alternativePackageNames Optional array of alternative package names to publish under
+     *
+     * **Warning:** This method uses simple string replacement for package names, which may have unintended effects
+     * if the package name appears in unexpected places. Use with caution.
+     */
+    static publish(alternativePackageNames?: string[]): Promise<void>;
+    /**
+     * Executes a dry run of npm publishing.
+     *
+     * @returns true if the dry run was successful, false otherwise.
+     */
+    private static publishDryRun;
+    /**
+     * Checks npm registry for package information and performs version conflict checks.
+     *
+     * @param packageName The package name from package.json
+     * @param currentVersion The current version from package.json
+     */
+    private static checkVersionConflicts;
+    /**
+     * Publishes the current project to npm.
+     *
+     * @returns true if the publish was successful, false otherwise.
+     */
+    private static publishToNpm;
+}
+//# sourceMappingURL=NpmPackageService.d.ts.map

package/lib/services/PackageService/NpmPackageService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NpmPackageService.d.ts","sourceRoot":"","sources":["../../../src/services/PackageService/NpmPackageService.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC;;;;;;;;;OASG;WACU,eAAe,CAAC,uBAAuB,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAmC/E;;;;;;;OAOG;WACU,OAAO,CAAC,uBAAuB,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgCvE;;;;OAIG;mBACkB,aAAa;IAalC;;;;;OAKG;mBACkB,qBAAqB;IAkC1C;;;;OAIG;mBACkB,YAAY;CAiBlC"}