@pnpm/registry-access.commands 1100.0.0 → 1100.1.0

package/lib/index.d.ts

@@ -1,5 +1,7 @@
 import * as deprecate from './deprecation/deprecate.js';
 import * as undeprecate from './deprecation/undeprecate.js';
 import * as distTag from './distTag.js';
+import * as ping from './ping.js';
+import * as search from './search.js';
 import * as unpublish from './unpublish.js';
-export { deprecate, distTag, undeprecate, unpublish };
+export { deprecate, distTag, ping, search, undeprecate, unpublish };

package/lib/index.js

@@ -1,6 +1,8 @@
 import * as deprecate from './deprecation/deprecate.js';
 import * as undeprecate from './deprecation/undeprecate.js';
 import * as distTag from './distTag.js';
+import * as ping from './ping.js';
+import * as search from './search.js';
 import * as unpublish from './unpublish.js';
-export { deprecate, distTag, undeprecate, unpublish };
+export { deprecate, distTag, ping, search, undeprecate, unpublish };
 //# sourceMappingURL=index.js.map

package/lib/ping.d.ts

@@ -0,0 +1,12 @@
+import { type CreateFetchFromRegistryOptions } from '@pnpm/network.fetch';
+import type { Registries, RegistryConfig } from '@pnpm/types';
+export declare function cliOptionsTypes(): Record<string, unknown>;
+export declare function rcOptionsTypes(): Record<string, unknown>;
+export interface PingOptions extends CreateFetchFromRegistryOptions {
+    registry?: string;
+    registries?: Registries;
+    configByUri?: Record<string, RegistryConfig>;
+}
+export declare const commandNames: string[];
+export declare function help(): string;
+export declare function handler(opts: PingOptions): Promise<string>;

package/lib/ping.js

@@ -0,0 +1,78 @@
+import util from 'node:util';
+import { docsUrl } from '@pnpm/cli.utils';
+import { PnpmError } from '@pnpm/error';
+import { createGetAuthHeaderByURI } from '@pnpm/network.auth-header';
+import { createFetchFromRegistry } from '@pnpm/network.fetch';
+import { renderHelp } from 'render-help';
+import { rcOptionsTypes as commonRcOptionsTypes } from './common.js';
+export function cliOptionsTypes() {
+    return {
+        ...commonRcOptionsTypes(),
+    };
+}
+export function rcOptionsTypes() {
+    return commonRcOptionsTypes();
+}
+export const commandNames = ['ping'];
+export function help() {
+    return renderHelp({
+        description: 'Test connectivity to the configured registry.',
+        descriptionLists: [
+            {
+                title: 'Options',
+                list: [
+                    {
+                        description: 'Test a specific registry URL',
+                        name: '--registry <url>',
+                    },
+                ],
+            },
+        ],
+        url: docsUrl('ping'),
+        usages: ['pnpm ping [--registry <url>]'],
+    });
+}
+export async function handler(opts) {
+    const registryUrl = opts.registry ?? opts.registries?.default ?? 'https://registry.npmjs.org/';
+    const normalizedRegistryUrl = registryUrl.endsWith('/') ? registryUrl : `${registryUrl}/`;
+    const pingUrlObject = new URL('./-/ping', normalizedRegistryUrl);
+    pingUrlObject.searchParams.set('write', 'true');
+    const pingUrl = pingUrlObject.toString();
+    const getAuthHeader = createGetAuthHeaderByURI(opts.configByUri ?? {}, normalizedRegistryUrl);
+    const authHeaderValue = getAuthHeader(normalizedRegistryUrl);
+    const fetchFromRegistry = createFetchFromRegistry(opts);
+    const start = Date.now();
+    let response;
+    try {
+        response = await fetchFromRegistry(pingUrl, {
+            retry: { retries: 0 },
+            authHeaderValue,
+        });
+    }
+    catch (err) {
+        const errorMessage = util.types.isNativeError(err) ? err.message : String(err);
+        throw new PnpmError('PING_ERROR', `Failed to reach registry: ${errorMessage}`);
+    }
+    if (!response.ok) {
+        throw new PnpmError('PING_ERROR', `Failed to reach registry: ${response.status} ${response.statusText}`.trimEnd());
+    }
+    const body = await response.text();
+    const time = Date.now() - start;
+    let details = '';
+    if (body) {
+        try {
+            const parsed = JSON.parse(body);
+            if (parsed && typeof parsed === 'object' && Object.keys(parsed).length > 0) {
+                details = JSON.stringify(parsed, null, 2);
+            }
+        }
+        catch {
+            // non-JSON body — ignore
+        }
+    }
+    const lines = [`PING ${registryUrl}`, `PONG ${time}ms`];
+    if (details)
+        lines.push(`PONG ${details}`);
+    return lines.join('\n');
+}
+//# sourceMappingURL=ping.js.map

package/lib/search.d.ts

@@ -0,0 +1,33 @@
+import { type CreateFetchFromRegistryOptions } from '@pnpm/network.fetch';
+import type { Registries, RegistryConfig } from '@pnpm/types';
+import { rcOptionsTypes } from './common.js';
+export { rcOptionsTypes };
+export declare function cliOptionsTypes(): Record<string, unknown>;
+export declare const commandNames: string[];
+export declare function help(): string;
+export interface SearchPackage {
+    name: string;
+    version: string;
+    description?: string;
+    date?: string;
+    author?: {
+        name: string;
+    } | string;
+    publisher?: {
+        username: string;
+    };
+    maintainers?: Array<{
+        username: string;
+    }>;
+    keywords?: string[];
+}
+export interface SearchResult {
+    package: SearchPackage;
+}
+export interface SearchOptions extends CreateFetchFromRegistryOptions {
+    configByUri?: Record<string, RegistryConfig>;
+    registries?: Registries;
+    json?: boolean;
+    searchLimit?: number;
+}
+export declare function handler(opts: SearchOptions, params: string[]): Promise<string>;

package/lib/search.js

@@ -0,0 +1,100 @@
+import { docsUrl } from '@pnpm/cli.utils';
+import { PnpmError } from '@pnpm/error';
+import { createGetAuthHeaderByURI } from '@pnpm/network.auth-header';
+import { createFetchFromRegistry } from '@pnpm/network.fetch';
+import chalk from 'chalk';
+import { renderHelp } from 'render-help';
+import { rcOptionsTypes } from './common.js';
+export { rcOptionsTypes };
+export function cliOptionsTypes() {
+    return {
+        ...rcOptionsTypes(),
+        json: Boolean,
+        'search-limit': Number,
+    };
+}
+export const commandNames = ['search', 's', 'se', 'find'];
+export function help() {
+    return renderHelp({
+        description: 'Search for packages in the registry.',
+        url: docsUrl('search'),
+        usages: [
+            'pnpm search <keyword> ...',
+        ],
+        descriptionLists: [
+            {
+                title: 'Options',
+                list: [
+                    {
+                        description: 'Show search results in JSON format',
+                        name: '--json',
+                    },
+                    {
+                        description: 'Maximum number of results to show (default: 20)',
+                        name: '--search-limit <number>',
+                    },
+                ],
+            },
+        ],
+    });
+}
+export async function handler(opts, params) {
+    const query = params.join(' ');
+    if (!query) {
+        throw new PnpmError('MISSING_SEARCH_QUERY', 'Search query is required. Usage: pnpm search <keyword>');
+    }
+    const registry = opts.registries?.default ?? 'https://registry.npmjs.org/';
+    const registryUrl = new URL(registry);
+    if (!registryUrl.pathname.endsWith('/')) {
+        registryUrl.pathname = `${registryUrl.pathname}/`;
+    }
+    const searchUrl = new URL('./-/v1/search', registryUrl);
+    searchUrl.searchParams.set('text', query);
+    searchUrl.searchParams.set('size', (opts.searchLimit ?? 20).toString());
+    const fetchFromRegistry = createFetchFromRegistry(opts);
+    const getAuthHeader = createGetAuthHeaderByURI(opts.configByUri ?? {}, opts.registries?.default);
+    const response = await fetchFromRegistry(searchUrl.toString(), {
+        authHeaderValue: getAuthHeader(registry),
+    });
+    if (!response.ok) {
+        const errorBody = (await response.text()).trim();
+        throw new PnpmError('SEARCH_FAILED', errorBody
+            ? `Search failed with status ${response.status}: ${response.statusText}. ${errorBody}`
+            : `Search failed with status ${response.status}: ${response.statusText}`);
+    }
+    const data = await response.json();
+    if (opts.json) {
+        return JSON.stringify(data.objects.map(obj => obj.package), null, 2);
+    }
+    if (data.objects.length === 0) {
+        return 'No packages found';
+    }
+    return data.objects.map(obj => formatPackage(obj.package)).join('\n\n');
+}
+function formatPackage(pkg) {
+    const author = typeof pkg.author === 'object'
+        ? pkg.author.name
+        : (pkg.author ?? pkg.publisher?.username ?? '');
+    const date = pkg.date ? pkg.date.split('T')[0] : '';
+    const lines = [
+        chalk.bold(pkg.name),
+    ];
+    if (pkg.description) {
+        lines.push(pkg.description);
+    }
+    const versionLine = [`Version ${pkg.version}`];
+    if (date)
+        versionLine.push(`published ${date}`);
+    if (author)
+        versionLine.push(`by ${author}`);
+    lines.push(versionLine.join(' '));
+    if (pkg.maintainers?.length) {
+        lines.push(`Maintainers: ${pkg.maintainers.map(m => m.username).join(', ')}`);
+    }
+    if (pkg.keywords?.length) {
+        lines.push(`Keywords: ${pkg.keywords.join(', ')}`);
+    }
+    lines.push(chalk.blueBright(`https://npmx.dev/package/${pkg.name}`));
+    return lines.join('\n');
+}
+//# sourceMappingURL=search.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/registry-access.commands",
-  "version": "1100.0.0",
+  "version": "1100.1.0",
   "description": "Commands for managing packages on the registry",
   "keywords": [
     "pnpm",
@@ -25,17 +25,18 @@
   ],
   "dependencies": {
     "@pnpm/npm-package-arg": "^2.0.0",
+    "chalk": "^5.6.0",
     "ramda": "npm:@pnpm/ramda@0.28.1",
     "render-help": "^2.0.0",
     "semver": "^7.7.2",
-    "@pnpm/cli.utils": "1100.0.0",
-    "@pnpm/config.pick-registry-for-package": "1100.0.0",
+    "@pnpm/config.reader": "1100.0.1",
+    "@pnpm/config.pick-registry-for-package": "1100.0.1",
     "@pnpm/error": "1100.0.0",
-    "@pnpm/network.auth-header": "1100.0.0",
-    "@pnpm/network.fetch": "1100.0.0",
-    "@pnpm/resolving.registry.types": "1100.0.0",
-    "@pnpm/types": "1100.0.0",
-    "@pnpm/config.reader": "1100.0.0"
+    "@pnpm/network.auth-header": "1100.0.1",
+    "@pnpm/network.fetch": "1100.0.1",
+    "@pnpm/resolving.registry.types": "1100.0.1",
+    "@pnpm/cli.utils": "1100.0.1",
+    "@pnpm/types": "1101.0.0"
   },
   "devDependencies": {
     "@jest/globals": "30.3.0",
@@ -43,10 +44,11 @@
     "@types/ramda": "0.31.1",
     "@types/semver": "7.7.1",
     "execa": "npm:safe-execa@0.3.0",
-    "@pnpm/prepare": "1100.0.0",
-    "@pnpm/releasing.commands": "1100.0.0",
-    "@pnpm/registry-access.commands": "1100.0.0",
-    "@pnpm/testing.command-defaults": "1100.0.0"
+    "@pnpm/prepare": "1100.0.1",
+    "@pnpm/registry-access.commands": "1100.1.0",
+    "@pnpm/testing.command-defaults": "1100.0.0",
+    "@pnpm/testing.mock-agent": "1100.0.1",
+    "@pnpm/releasing.commands": "1100.0.1"
   },
   "engines": {
     "node": ">=22.13"