@verdaccio/e2e-cli 2.1.0 → 2.2.0

package/build/types.d.ts

@@ -0,0 +1,65 @@
+/// <reference types="node" />
+import { SpawnOptions } from 'child_process';
+export type ExecOutput = {
+    stdout: string;
+    stderr: string;
+};
+export type ExecFn = (options: SpawnOptions, ...args: string[]) => Promise<ExecOutput>;
+export type TestContext = {
+    registryUrl: string;
+    token: string;
+    port: number;
+    exec: ExecFn;
+    adapter: PackageManagerAdapter;
+    /** Unique suffix for package names to avoid conflicts across runs */
+    runId: string;
+};
+export type TestResult = {
+    name: string;
+    passed: boolean;
+    duration: number;
+    error?: string;
+};
+export type SuiteResult = {
+    adapter: string;
+    tests: TestResult[];
+    passed: number;
+    failed: number;
+    skipped: number;
+    duration: number;
+};
+export type TestDefinition = {
+    name: string;
+    run: (ctx: TestContext) => Promise<void>;
+    /** Commands required for this test (e.g. 'deprecate', 'star'). Skipped if adapter doesn't support them. */
+    requires?: string[];
+};
+export interface PackageManagerAdapter {
+    /** Display name, e.g. "npm@10" */
+    name: string;
+    /** Package manager type: npm, pnpm, yarn-classic, yarn-modern */
+    type: 'npm' | 'pnpm' | 'yarn-classic' | 'yarn-modern';
+    /** Resolved path to the binary */
+    bin: string;
+    /** Commands this PM supports */
+    supports: Set<string>;
+    /** Build --registry args */
+    registryArg(url: string): string[];
+    /** Build --prefix / --cwd args */
+    prefixArg(folder: string): string[];
+    /** Execute a command with this PM */
+    exec(options: SpawnOptions, ...args: string[]): Promise<ExecOutput>;
+    /** Prepare a temp project for testing. Returns path to temp folder. */
+    prepareProject(packageName: string, version: string, registryUrl: string, port: number, token: string, dependencies?: Record<string, string>, devDependencies?: Record<string, string>): Promise<{
+        tempFolder: string;
+    }>;
+}
+export type CliOptions = {
+    registry: string;
+    pm?: string[];
+    test?: string[];
+    concurrency: number;
+    timeout: number;
+    token?: string;
+    verbose: boolean;
+};

package/build/utils/index.d.ts

@@ -0,0 +1,3 @@
+export { exec, setVerbose } from './process';
+export { createTempFolder, getPackageJSON, getREADME, prepareGenericEmptyProject } from './project';
+export { createUser, pingRegistry } from './registry-client';

package/build/utils/process.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+import { SpawnOptions } from 'child_process';
+import { ExecOutput } from '../types';
+export declare function setVerbose(v: boolean): void;
+export declare function exec(options: SpawnOptions, cmd: string, args: string[]): Promise<ExecOutput>;

package/build/utils/project.d.ts

@@ -0,0 +1,6 @@
+export declare function createTempFolder(prefix: string): Promise<string>;
+export declare function getPackageJSON(packageName: string, version?: string, dependencies?: Record<string, string>, devDependencies?: Record<string, string>): string;
+export declare function getREADME(packageName: string): string;
+export declare function prepareGenericEmptyProject(packageName: string, version: string, port: number, token: string, registryDomain: string, dependencies?: Record<string, string>, devDependencies?: Record<string, string>): Promise<{
+    tempFolder: string;
+}>;

package/build/utils/registry-client.d.ts

@@ -0,0 +1,14 @@
+export type RegistryAuth = {
+    token: string;
+    user: string;
+};
+/**
+ * Creates a user on the registry and returns the auth token.
+ * Uses a unique username per run to avoid 409 conflicts.
+ * Works against any running Verdaccio instance with htpasswd auth.
+ */
+export declare function createUser(registryUrl: string, user?: string, password?: string): Promise<RegistryAuth>;
+/**
+ * Ping the registry to check it's alive.
+ */
+export declare function pingRegistry(registryUrl: string): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/e2e-cli",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "type": "module",
   "license": "MIT",
   "description": "CLI tool to run Verdaccio e2e tests against any running registry",