feat: Changed npm install to a single string command instead of string + object.

Author: kevinwang5658

completions-cron/package.json

@@ -8,7 +8,8 @@
 		"start": "wrangler dev --test-scheduled",
 		"cf-typegen": "wrangler types",
     "start:cron": "curl http://localhost:8787/__scheduled?cron=*+*+*+*+*",
-    "gen-types": "npx supabase gen types typescript --project-id kdctbvqvqjfquplxhqrm > ./types/database.types.d.ts"
+    "gen-types": "npx supabase gen types typescript --project-id kdctbvqvqjfquplxhqrm > ./types/database.types.d.ts",
+    "test:completions": "../node_modules/.bin/tsx src/test-completions.ts"
   },
 	"devDependencies": {
     "@types/node": "^24.10.1",

completions-cron/src/__generated__/completions-index.ts

@@ -2,11 +2,6 @@ import { ParameterSetting, Plan, StatefulParameter, getPty } from '@codifycli/pl
 
 import { NpmConfig } from './npm.js';
 
-export interface NpmPackage {
-  name: string;
-  version?: string;
-}
-
 interface NpmLsResponse {
   version: string;
   name: string;
@@ -17,18 +12,24 @@ interface NpmLsResponse {
   }>;
 }
 
-export class NpmGlobalInstallParameter extends StatefulParameter<NpmConfig, Array<NpmPackage | string>> {
+// Extracts the package name without the version specifier (e.g. "nodemon@3.1.10" → "nodemon")
+function packageName(pkg: string): string {
+  const atIndex = pkg.lastIndexOf('@')
+  return atIndex > 0 ? pkg.slice(0, atIndex) : pkg
+}
+
+export class NpmInstallParameter extends StatefulParameter<NpmConfig, string[]> {
 
   getSettings(): ParameterSetting {
     return {
       type: 'array',
       isElementEqual: this.isEqual,
       filterInStatelessMode: (desired, current) =>
-        current.filter((c) => desired.some((d) => this.isSamePackage(d, c))),
+        current.filter((c) => desired.some((d) => packageName(d) === packageName(c))),
     }
   }
 
-  async refresh(desired: (NpmPackage | string)[] | null, config: Partial<NpmConfig>): Promise<(NpmPackage | string)[] | null> {
+  async refresh(desired: string[] | null, config: Partial<NpmConfig>): Promise<string[] | null> {
     const pty = getPty();
 
     const { data } = await pty.spawnSafe('npm ls --json --global --depth=0 --loglevel=silent')
@@ -37,106 +38,56 @@ export class NpmGlobalInstallParameter extends StatefulParameter<NpmConfig, Arra
     }
 
     const parsedData = JSON.parse(data) as NpmLsResponse;
-    const dependencies = Object.entries(parsedData.dependencies ?? {})
-      .map(([name, info]) => ({
-        name,
-        version: info.version,
-      }))
-
-    return dependencies.map((c) => {
-      if (desired?.some((d) => typeof d === 'string' && d === c.name)) {
-        return c.name;
-      }
 
-      if(desired?.some((d) => typeof d === 'object' && d.name === c.name && !d.version)) {
-        return { name: c.name };
+    return Object.entries(parsedData.dependencies ?? {}).map(([name, info]) => {
+      // If desired entry has a version specifier, return name@version so equality checks work
+      if (desired?.some((d) => d.includes('@') && packageName(d) === name)) {
+        return `${name}@${info.version}`
       }
-
-      return c;
+      return name
     })
   }
 
-  async add(valueToAdd: Array<NpmPackage | string>, plan: Plan<NpmConfig>): Promise<void> {
+  async add(valueToAdd: string[], plan: Plan<NpmConfig>): Promise<void> {
     await this.install(valueToAdd);
   }
 
-  async modify(newValue: (NpmPackage | string)[], previousValue: (NpmPackage | string)[], plan: Plan<NpmConfig>): Promise<void> {
-    const toInstall = newValue.filter((n) => !previousValue.some((p) => this.isSamePackage(n, p)));
-    const toUninstall = previousValue.filter((p) => !newValue.some((n) => this.isSamePackage(n, p)));
+  async modify(newValue: string[], previousValue: string[], plan: Plan<NpmConfig>): Promise<void> {
+    const toInstall = newValue.filter((n) => !previousValue.some((p) => packageName(n) === packageName(p)));
+    const toUninstall = previousValue.filter((p) => !newValue.some((n) => packageName(n) === packageName(p)));
 
     if (plan.isStateful && toUninstall.length > 0) {
       await this.uninstall(toUninstall);
     }
     await this.install(toInstall);
   }
 
-  async remove(valueToRemove: (NpmPackage | string)[], plan: Plan<NpmConfig>): Promise<void> {
+  async remove(valueToRemove: string[], plan: Plan<NpmConfig>): Promise<void> {
     await this.uninstall(valueToRemove);
   }
 
-  async install(packages: Array<NpmPackage | string>): Promise<void> {
-    const $ = getPty();
-    const installStatements = packages.map((p) => {
-      if (typeof p === 'string') {
-        return p;
-      }
-
-      if (p.version) {
-        return `${p.name}@${p.version}`;
-      }
-
-      return p.name;
-    })
-
-    if (installStatements.length === 0) {
+  async install(packages: string[]): Promise<void> {
+    if (packages.length === 0) {
       return;
     }
-
-    await $.spawn(`npm install --global ${installStatements.join(' ')}`, { interactive: true });
-  }
-
-  async uninstall(packages: Array<NpmPackage | string>): Promise<void> {
     const $ = getPty();
-    const uninstallStatements = packages.map((p) => {
-      if (typeof p === 'string') {
-        return p;
-      }
-
-      return p.name;
-    })
-
-    if (uninstallStatements.length === 0) {
-      return;
-    }
-
-    await $.spawn(`npm uninstall --global ${uninstallStatements.join(' ')}`, { interactive: true });
+    await $.spawn(`npm install --global ${packages.join(' ')}`, { interactive: true });
   }
 
-
-  isSamePackage(desired: NpmPackage | string, current: NpmPackage | string): boolean {
-    if (typeof desired === 'string' && typeof current === 'string') {
-      return desired === current;
-    }
-
-    if (typeof desired === 'object' && typeof current === 'object') {
-      return desired.name === current.name;
+  async uninstall(packages: string[]): Promise<void> {
+    if (packages.length === 0) {
+      return;
     }
-
-    return false;
+    const $ = getPty();
+    await $.spawn(`npm uninstall --global ${packages.map(packageName).join(' ')}`, { interactive: true });
   }
 
-  isEqual(desired: NpmPackage | string, current: NpmPackage | string): boolean {
-    if (typeof desired === 'string' && typeof current === 'string') {
-      return desired === current;
-    }
-
-    if (typeof desired === 'object' && typeof current === 'object') {
-      return desired.version
-        ? desired.name === current.name && desired.version === current.version
-        : desired.name === current.name;
+  isEqual(desired: string, current: string): boolean {
+    // If no version specified in desired, match by name only
+    if (!desired.includes('@') || desired.startsWith('@')) {
+      return packageName(desired) === packageName(current)
     }
-
-    return false;
+    return desired === current
   }
 
 }

src/resources/javascript/npm/completions/npm.globalInstall.ts

@@ -6,21 +6,12 @@
   "description": "Install and manage packages using NPM.",
   "type": "object",
   "properties": {
-    "globalInstall": {
+    "install": {
       "type": "array",
-      "description": "An array of",
+      "description": "An array of npm packages to install globally. Use the npm@version syntax to pin a specific version (e.g. \"nodemon@3.1.10\").",
       "items": {
-        "oneOf": [
-          { "type": "string", "description": "Npm packages to install globally" },
-          {
-            "type": "object",
-            "properties": {
-              "name": { "type": "string", "description": "The name of the package to install" },
-              "version": { "type": "string", "description": "The version of package to install" }
-            },
-            "required": ["name"]
-          }
-        ]
+        "type": "string",
+        "description": "Package name, optionally with a version specifier (e.g. \"typescript\" or \"typescript@5.4.0\")"
       }
     }
   },

src/resources/javascript/npm/completions/npm.install.ts

@@ -1,11 +1,11 @@
 import { Resource, ResourceSettings, getPty } from '@codifycli/plugin-core';
-import { OS, ResourceConfig } from '@codifycli/schemas';
+import { OS, ResourceConfig } from '@codifycli/schemas'
 
-import { NpmGlobalInstallParameter, NpmPackage } from './global-install.js';
+import { NpmInstallParameter } from './global-install.js';
 import schema from './npm-schema.json'
 
 export interface NpmConfig extends ResourceConfig {
-  globalInstall: Array<NpmPackage | string>
+  install: string[]
 }
 
 export class Npm extends Resource<NpmConfig> {
@@ -15,7 +15,7 @@ export class Npm extends Resource<NpmConfig> {
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       parameterSettings: {
-        globalInstall: { type: 'stateful', definition: new NpmGlobalInstallParameter() },
+        install: { type: 'stateful', definition: new NpmInstallParameter() },
       },
       importAndDestroy: {
         preventDestroy: true,