@pnpm/releasing.exportable-manifest 1100.1.14 → 1100.2.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @pnpm/exportable-manifest
 
+## 1100.2.0
+
+### Minor Changes
+
+- Added support for `publishConfig.name`, which publishes a package under a different name than the one its manifest carries in the workspace. It is for a project whose published name is already taken by a sibling project, which otherwise has to be renamed by a build step just before publishing. Only the published artifact is renamed — dependents, `pnpm-lock.yaml`, and release tooling keep addressing the project by its manifest name — and the new name reaches the packed manifest, the tarball filename, and everything that addresses the package at the registry: the already-published check of `pnpm publish -r`, its registry selection, and the release-planning probes of `pnpm change status` and `pnpm version -r` [#13345](https://github.com/pnpm/pnpm/issues/13345).
+
+### Patch Changes
+
+- Updated dependencies:
+  - @pnpm/bins.resolver@1100.0.12
+  - @pnpm/types@1101.7.0
+  - @pnpm/workspace.project-manifest-reader@1100.0.21
+
+## 1100.1.15
+
+### Patch Changes
+
+- Republished every package: the tarballs published by the v11.13.1 through v11.16.0 releases were missing most of their compiled files due to a packing bug [#13164](https://github.com/pnpm/pnpm/issues/13164).
+
+- Updated dependencies:
+  - @pnpm/bins.resolver@1100.0.11
+  - @pnpm/catalogs.resolver@1100.0.1
+  - @pnpm/error@1100.1.0
+  - @pnpm/resolving.jsr-specifier-parser@1100.0.3
+  - @pnpm/types@1101.6.0
+  - @pnpm/workspace.project-manifest-reader@1100.0.20
+
 ## 1100.1.14
 
 ### Patch Changes

package/lib/index.d.ts

@@ -0,0 +1,19 @@
+import type { Catalogs } from '@pnpm/catalogs.types';
+import type { Hooks } from '@pnpm/hooks.pnpmfile';
+import type { ProjectManifest } from '@pnpm/types';
+import { type ExportedManifest } from './transform/index.js';
+export { type ExportedManifest };
+export interface MakePublishManifestOptions {
+    catalogs: Catalogs;
+    hooks?: Hooks;
+    modulesDir?: string;
+    skipManifestObfuscation?: boolean;
+    embedReadme?: boolean;
+}
+export declare function createExportableManifest(dir: string, originalManifest: ProjectManifest, opts: MakePublishManifestOptions): Promise<ExportedManifest>;
+export declare function readReadmeFile(projectDir: string): Promise<string | undefined>;
+export type PublishDependencyConverter = (depName: string, depSpec: string, dir: string, modulesDir?: string) => Promise<string> | string;
+export interface MakePublishDependenciesOpts {
+    readonly modulesDir?: string;
+    readonly convertDependencyForPublish: PublishDependencyConverter;
+}

package/lib/overridePublishConfig.d.ts

@@ -0,0 +1,2 @@
+import type { ProjectManifest } from '@pnpm/types';
+export declare function overridePublishConfig(publishManifest: ProjectManifest): void;

package/lib/overridePublishConfig.js

@@ -0,0 +1,47 @@
+import { isEmpty } from 'ramda';
+// property keys that are copied from publishConfig into the manifest
+const PUBLISH_CONFIG_WHITELIST = new Set([
+    // Lets a package be published under a name it cannot carry in the workspace
+    // — typically because a sibling project already owns that name. Nothing else
+    // in the workspace observes the rename: dependents, pnpm-lock.yaml, and the
+    // changeset ledger all keep addressing the project by its manifest name.
+    'name',
+    // manifest fields that may make sense to overwrite
+    'bin',
+    'engines',
+    'type',
+    'imports',
+    // https://github.com/stereobooster/package.json#package-bundlers
+    'main',
+    'module',
+    'typings',
+    'types',
+    'exports',
+    'browser',
+    'esnext',
+    'es2015',
+    'unpkg',
+    'umd:main',
+    // These are useful to hide in order to avoid warnings during local development
+    'os',
+    'cpu',
+    'libc',
+    // https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#version-selection-with-typesversions
+    'typesVersions',
+]);
+export function overridePublishConfig(publishManifest) {
+    const { publishConfig } = publishManifest;
+    if (!publishConfig)
+        return;
+    for (const key in publishConfig) {
+        if (!PUBLISH_CONFIG_WHITELIST.has(key))
+            continue;
+        const value = publishConfig[key];
+        publishManifest[key] = value; // eslint-disable-line @typescript-eslint/no-explicit-any
+        delete publishConfig[key];
+    }
+    if (isEmpty(publishConfig)) {
+        delete publishManifest.publishConfig;
+    }
+}
+//# sourceMappingURL=overridePublishConfig.js.map

package/lib/transform/bin.d.ts

@@ -0,0 +1,16 @@
+import { PnpmError } from '@pnpm/error';
+import type { ProjectManifest } from '@pnpm/types';
+import type { ExportedManifest } from './index.js';
+type Input = Pick<ProjectManifest, 'bin'> & Pick<ExportedManifest, 'name'>;
+type Output<Manifest extends Input> = Omit<Manifest, 'bin'> & Pick<ExportedManifest, 'bin'>;
+export declare function transformBin<Manifest extends Input>(manifest: Manifest): Output<Manifest>;
+/**
+ * The property `"bin"` of a `package.json` could be either an object or a string.
+ * This function normalizes either forms into an object.
+ */
+export declare function normalizeBinObject(pkgName: string, bin: string | Record<string, string>): Record<string, string>;
+export declare class InvalidScopedPackageNameError extends PnpmError {
+    readonly invalidName: string;
+    constructor(invalidName: string);
+}
+export {};

package/lib/transform/bin.js

@@ -0,0 +1,37 @@
+import { PnpmError } from '@pnpm/error';
+export function transformBin(manifest) {
+    if (manifest.bin == null || typeof manifest.bin === 'object')
+        return manifest;
+    const { bin, ...rest } = manifest;
+    return {
+        ...rest,
+        bin: normalizeBinObject(manifest.name, bin),
+    };
+}
+/**
+ * The property `"bin"` of a `package.json` could be either an object or a string.
+ * This function normalizes either forms into an object.
+ */
+export function normalizeBinObject(pkgName, bin) {
+    if (typeof bin === 'object')
+        return bin;
+    const binName = normalizeBinName(pkgName);
+    return { [binName]: bin };
+}
+function normalizeBinName(name) {
+    if (name[0] !== '@')
+        return name;
+    const slashIndex = name.indexOf('/');
+    if (slashIndex < 0) {
+        throw new InvalidScopedPackageNameError(name);
+    }
+    return name.slice(slashIndex + 1);
+}
+export class InvalidScopedPackageNameError extends PnpmError {
+    invalidName;
+    constructor(invalidName) {
+        super('INVALID_SCOPED_PACKAGE_NAME', `The name ${JSON.stringify(invalidName)} is not a valid scoped package name`);
+        this.invalidName = invalidName;
+    }
+}
+//# sourceMappingURL=bin.js.map

package/lib/transform/index.d.ts

@@ -0,0 +1,5 @@
+import type { PackageJSON as ExportedManifest } from '@npm/types';
+import type { ProjectManifest } from '@pnpm/types';
+export { type ExportedManifest };
+export type Transform = (manifest: ProjectManifest) => ExportedManifest;
+export declare const transform: Transform;

package/lib/transform/index.js

@@ -0,0 +1,8 @@
+import { pipe } from 'ramda';
+import { transformBin } from './bin.js';
+import { transformPeerDependenciesMeta } from './peerDependenciesMeta.js';
+import { transformRepository } from './repository.js';
+import { transformRequiredFields } from './requiredFields.js';
+export {};
+export const transform = pipe(transformRequiredFields, transformBin, transformPeerDependenciesMeta, transformRepository);
+//# sourceMappingURL=index.js.map

package/lib/transform/peerDependenciesMeta.d.ts

@@ -0,0 +1,7 @@
+import type { ProjectManifest } from '@pnpm/types';
+import type { ExportedManifest } from './index.js';
+type Input = Pick<ProjectManifest, 'peerDependenciesMeta'>;
+type Omitted<Manifest extends Input> = Omit<Manifest, 'peerDependenciesMeta'>;
+type Output<Manifest extends Input> = Omitted<Manifest> & Pick<ExportedManifest, 'peerDependenciesMeta'>;
+export declare function transformPeerDependenciesMeta<Manifest extends Input>(manifest: Manifest): Output<Manifest>;
+export {};

package/lib/transform/peerDependenciesMeta.js

@@ -0,0 +1,18 @@
+export function transformPeerDependenciesMeta(manifest) {
+    if (!manifest.peerDependenciesMeta)
+        return manifest;
+    const inputPeerDepsMeta = manifest.peerDependenciesMeta;
+    const outputPeerDepsMeta = {};
+    for (const key in inputPeerDepsMeta) {
+        const { optional, ...rest } = inputPeerDepsMeta[key];
+        outputPeerDepsMeta[key] = {
+            ...rest,
+            optional: optional ?? false,
+        };
+    }
+    return {
+        ...manifest,
+        peerDependenciesMeta: outputPeerDepsMeta,
+    };
+}
+//# sourceMappingURL=peerDependenciesMeta.js.map

package/lib/transform/repository.d.ts

@@ -0,0 +1,15 @@
+import type { ProjectManifest } from '@pnpm/types';
+import type { ExportedManifest } from './index.js';
+type Input = Pick<ProjectManifest, 'repository'>;
+type Output<Manifest extends Input> = Omit<Manifest, 'repository'> & Pick<ExportedManifest, 'repository'>;
+/**
+ * Normalizes a string `repository` into the object form `{ type: 'git', url }`.
+ *
+ * npm's `normalize-package-data` performs this conversion before publishing, so a
+ * package whose `repository` is a bare URL string still reaches the registry as an
+ * object. Some registries (e.g. Gitea) reject a string `repository` with a 500
+ * because they decode it into an object-typed struct. Matching npm keeps
+ * `pnpm publish` compatible with them. See https://github.com/pnpm/pnpm/issues/12099.
+ */
+export declare function transformRepository<Manifest extends Input>(manifest: Manifest): Output<Manifest>;
+export {};

package/lib/transform/repository.js

@@ -0,0 +1,21 @@
+/**
+ * Normalizes a string `repository` into the object form `{ type: 'git', url }`.
+ *
+ * npm's `normalize-package-data` performs this conversion before publishing, so a
+ * package whose `repository` is a bare URL string still reaches the registry as an
+ * object. Some registries (e.g. Gitea) reject a string `repository` with a 500
+ * because they decode it into an object-typed struct. Matching npm keeps
+ * `pnpm publish` compatible with them. See https://github.com/pnpm/pnpm/issues/12099.
+ */
+export function transformRepository(manifest) {
+    if (typeof manifest.repository !== 'string')
+        return manifest;
+    return {
+        ...manifest,
+        repository: {
+            type: 'git',
+            url: manifest.repository,
+        },
+    };
+}
+//# sourceMappingURL=repository.js.map

package/lib/transform/requiredFields.d.ts

@@ -0,0 +1,12 @@
+import { PnpmError } from '@pnpm/error';
+import type { ProjectManifest } from '@pnpm/types';
+import type { ExportedManifest } from './index.js';
+type RequiredField = 'name' | 'version';
+type Input = Pick<ProjectManifest, RequiredField>;
+type Output<Manifest extends Input> = Omit<Manifest, RequiredField> & Pick<ExportedManifest, RequiredField>;
+export declare function transformRequiredFields<Manifest extends Input>(manifest: Manifest): Output<Manifest>;
+export declare class MissingRequiredFieldError<Field extends RequiredField> extends PnpmError {
+    readonly field: Field;
+    constructor(field: Field);
+}
+export {};

package/lib/transform/requiredFields.js

@@ -0,0 +1,16 @@
+import { PnpmError } from '@pnpm/error';
+export function transformRequiredFields(manifest) {
+    if (!manifest.name)
+        throw new MissingRequiredFieldError('name');
+    if (!manifest.version)
+        throw new MissingRequiredFieldError('version');
+    return manifest;
+}
+export class MissingRequiredFieldError extends PnpmError {
+    field;
+    constructor(field) {
+        super('MISSING_REQUIRED_FIELD', `Missing required field ${JSON.stringify(field)}`);
+        this.field = field;
+    }
+}
+//# sourceMappingURL=requiredFields.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/releasing.exportable-manifest",
-  "version": "1100.1.14",
+  "version": "1100.2.0",
   "description": "Creates an exportable manifest",
   "keywords": [
     "pnpm",
@@ -28,24 +28,24 @@
   ],
   "dependencies": {
     "@npm/types": "^2.1.0",
-    "@pnpm/bins.resolver": "1100.0.10",
-    "@pnpm/catalogs.resolver": "1100.0.0",
-    "@pnpm/error": "1100.0.1",
-    "@pnpm/resolving.jsr-specifier-parser": "1100.0.2",
-    "@pnpm/types": "1101.5.0",
-    "@pnpm/workspace.project-manifest-reader": "1100.0.19",
+    "@pnpm/bins.resolver": "1100.0.12",
+    "@pnpm/catalogs.resolver": "1100.0.1",
+    "@pnpm/error": "1100.1.0",
+    "@pnpm/resolving.jsr-specifier-parser": "1100.0.3",
+    "@pnpm/types": "1101.7.0",
+    "@pnpm/workspace.project-manifest-reader": "1100.0.21",
     "p-map-values": "^0.1.0",
     "ramda": "npm:@pnpm/ramda@0.28.1"
   },
   "devDependencies": {
     "@jest/globals": "30.4.1",
-    "@pnpm/catalogs.config": "1100.0.2",
-    "@pnpm/catalogs.types": "1100.0.0",
-    "@pnpm/hooks.pnpmfile": "1100.0.21",
-    "@pnpm/prepare": "1100.0.21",
-    "@pnpm/releasing.exportable-manifest": "1100.1.14",
+    "@pnpm/catalogs.config": "1100.0.3",
+    "@pnpm/catalogs.types": "1100.0.1",
+    "@pnpm/hooks.pnpmfile": "1100.0.23",
+    "@pnpm/prepare": "1100.0.23",
+    "@pnpm/releasing.exportable-manifest": "1100.2.0",
     "@types/cross-spawn": "^6.0.6",
-    "@types/ramda": "0.31.1",
+    "@types/ramda": "0.32.0",
     "cross-spawn": "^7.0.6",
     "write-yaml-file": "^6.0.0"
   },