Enable using apiops from public npm registry

Author: Peter Hauge

src/cli/init-command.ts

@@ -17,7 +17,7 @@ interface InitOptions {
   nonInteractive: boolean;
   artifactDir: string;
   environments: string;
-  cliPackage: string;
+  cliPackage?: string;
   force: boolean;
 }
 
@@ -31,7 +31,7 @@ export function createInitCommand(): Command {
     .option('--non-interactive', 'Skip interactive prompts (requires --ci)', false)
     .option('--artifact-dir <dir>', 'Artifact directory path', './apim-artifacts')
     .option('--environments <list>', 'Comma-separated environment names', 'dev,prod')
-    .requiredOption('--cli-package <path>', 'Path to apiops npm tarball (from npm pack)')
+    .option('--cli-package <path>', 'Path to apiops npm tarball (from npm pack). If not provided, uses @peterhauge/apiops-cli from npm registry')
     .option('--force', 'Overwrite existing files without prompting', false)
     .action(async (options: InitOptions) => {
       try {

src/models/config.ts

@@ -88,6 +88,6 @@ export interface InitConfig {
   artifactDir: string;
   environments: string[];
   outputDir: string;
-  cliPackage: string;
+  cliPackage?: string;
   force: boolean;
 }

src/services/init-service.ts

@@ -49,8 +49,10 @@ class InitServiceImpl implements InitService {
   async run(config: InitConfig): Promise<GeneratedFiles> {
     logger.info('Starting APIM repository initialization...');
 
-    // Validate that the CLI package tarball exists
-    await this.validateCliPackage(config.cliPackage);
+    // Validate that the CLI package tarball exists (only if provided)
+    if (config.cliPackage) {
+      await this.validateCliPackage(config.cliPackage);
+    }
 
     // Gather configuration (interactive or from flags)
     const finalConfig = await this.gatherConfiguration(config);
@@ -247,17 +249,24 @@ class InitServiceImpl implements InitService {
     await fs.writeFile(gitkeepPath, '');
     generatedFiles.directories.push(config.artifactDir);
 
-    // Copy CLI tarball into .apiops/ directory
-    const apiopsDir = path.join(config.outputDir, '.apiops');
-    await fs.mkdir(apiopsDir, { recursive: true });
-    const tarballFilename = path.basename(config.cliPackage);
-    const tarballDest = path.join(apiopsDir, tarballFilename);
-    await fs.copyFile(path.resolve(config.cliPackage), tarballDest);
-    generatedFiles.directories.push('.apiops');
-
-    // Generate package.json with local tarball dependency
-    const tarballRelPath = path.join('.apiops', tarballFilename);
-    const packageJsonContent = generatePackageJson({ tarballRelPath });
+    // Generate package.json - mode depends on whether cliPackage is provided
+    let packageJsonContent: string;
+    if (config.cliPackage) {
+      // Local tarball mode: copy tarball and reference via file: dependency
+      const apiopsDir = path.join(config.outputDir, '.apiops');
+      await fs.mkdir(apiopsDir, { recursive: true });
+      const tarballFilename = path.basename(config.cliPackage);
+      const tarballDest = path.join(apiopsDir, tarballFilename);
+      await fs.copyFile(path.resolve(config.cliPackage), tarballDest);
+      generatedFiles.directories.push('.apiops');
+
+      const tarballRelPath = path.join('.apiops', tarballFilename);
+      packageJsonContent = generatePackageJson({ mode: 'local', tarballRelPath });
+    } else {
+      // Public npm mode: use registry package
+      packageJsonContent = generatePackageJson({ mode: 'npm' });
+    }
+
     const packageJsonPath = path.join(config.outputDir, 'package.json');
     await fs.writeFile(packageJsonPath, packageJsonContent);
     generatedFiles.configs.push('package.json');

src/templates/configs/package-json.ts

@@ -1,26 +1,29 @@
 /**
  * Generates a package.json for the target repo that references
- * the apiops CLI tarball via a local file dependency.
+ * either a local apiops CLI tarball or the public npm package.
  */
 
-export interface PackageJsonConfig {
-  /** Relative path from the target repo root to the copied tarball (e.g. '.apiops/apiops-0.1.0.tgz') */
-  tarballRelPath: string;
-}
+export type PackageJsonConfig =
+  | { mode: 'local'; tarballRelPath: string }
+  | { mode: 'npm' };
 
 export function generatePackageJson(config: PackageJsonConfig): string {
-  // Use forward slashes in the file: dependency regardless of OS
-  const posixPath = config.tarballRelPath.replace(/\\/g, '/');
-
-  const pkg = {
+  const pkg: Record<string, unknown> = {
     name: 'apim-ops-repo',
     version: '1.0.0',
     private: true,
     description: 'Azure API Management configuration-as-code repository',
-    dependencies: {
-      apiops: `file:${posixPath}`,
-    },
+    dependencies: {},
   };
 
+  if (config.mode === 'local') {
+    // Use forward slashes in the file: dependency regardless of OS
+    const posixPath = config.tarballRelPath.replace(/\\/g, '/');
+    (pkg.dependencies as Record<string, string>).apiops = `file:${posixPath}`;
+  } else {
+    // Public npm registry mode
+    (pkg.dependencies as Record<string, string>)['@peterhauge/apiops-cli'] = 'latest';
+  }
+
   return JSON.stringify(pkg, null, 2) + '\n';
 }