@jsdevtools/npm-publish 2.0.0 → 2.1.0

package/src/read-manifest.ts

@@ -5,14 +5,9 @@ import { list as tarList, type ReadEntry } from "tar";
 
 import * as errors from "./errors.js";
 
-/** The result of reading a package manifest */
-export interface ManifestReadResult {
-  packageSpec: string;
-  manifest: PackageManifest;
-}
-
-/** A package manifest (package.json) */
+/** A package manifest (package.json) and associated details. */
 export interface PackageManifest {
+  packageSpec: string;
   name: string;
   version: string;
   scope: string | undefined;
@@ -24,6 +19,7 @@ export interface PackagePublishConfig {
   tag?: string;
   access?: string;
   registry?: string;
+  provenance?: boolean;
 }
 
 const SCOPE_RE = /^(@.+)\/.+$/u;
@@ -86,7 +82,7 @@ const readTarballPackageJson = async (file: string): Promise<string> => {
  */
 export async function readManifest(
   packagePath: unknown
-): Promise<ManifestReadResult> {
+): Promise<PackageManifest> {
   let packageSpec: string | undefined;
   let manifestContents: string;
 
@@ -138,6 +134,9 @@ export async function readManifest(
 
   return {
     packageSpec,
-    manifest: { name, version, publishConfig, scope: SCOPE_RE.exec(name)?.[1] },
+    name,
+    version,
+    publishConfig,
+    scope: SCOPE_RE.exec(name)?.[1],
   };
 }

package/src/results.ts

@@ -1,5 +1,10 @@
 import type { Access, Strategy } from "./options.js";
-import type { ReleaseType } from "./compare-versions.js";
+import type { ReleaseType as SemverReleaseType } from "semver";
+
+/** Release type */
+export type ReleaseType = SemverReleaseType | typeof INITIAL | typeof DIFFERENT;
+export const INITIAL = "initial";
+export const DIFFERENT = "different";
 
 /** Results of the publish */
 export interface Results {

package/lib/compare-versions.d.ts

@@ -1,20 +0,0 @@
-import { type ReleaseType as SemverReleaseType } from "semver";
-import type { NormalizedOptions } from "./normalize-options.js";
-import type { PublishedVersions } from "./npm/index.js";
-export type ReleaseType = SemverReleaseType | typeof INITIAL | typeof DIFFERENT;
-export interface VersionComparison {
-    type: ReleaseType | undefined;
-    oldVersion: string | undefined;
-}
-declare const INITIAL = "initial";
-declare const DIFFERENT = "different";
-/**
- * Compare previously published versions with the package's current version.
- *
- * @param version The current package version.
- * @param publishedVersions The versions that have already been published.
- * @param options Configuration options
- * @returns The release type and previous version.
- */
-export declare function compareVersions(version: string, publishedVersions: PublishedVersions, options: NormalizedOptions): VersionComparison;
-export {};

package/lib/compare-versions.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareVersions = void 0;
-const semver_1 = require("semver");
-const options_js_1 = require("./options.js");
-const INITIAL = "initial";
-const DIFFERENT = "different";
-/**
- * Compare previously published versions with the package's current version.
- *
- * @param version The current package version.
- * @param publishedVersions The versions that have already been published.
- * @param options Configuration options
- * @returns The release type and previous version.
- */
-function compareVersions(version, publishedVersions, options) {
-    const { versions: existingVersions, "dist-tags": tags } = publishedVersions;
-    const { strategy, tag: publishTag } = options;
-    const oldVersion = (0, semver_1.valid)(tags[publishTag.value]) ?? undefined;
-    const isUnique = !existingVersions.includes(version);
-    let type;
-    if (isUnique) {
-        if (!oldVersion) {
-            type = INITIAL;
-        }
-        else if ((0, semver_1.gt)(version, oldVersion)) {
-            type = (0, semver_1.diff)(version, oldVersion) ?? DIFFERENT;
-        }
-        else if (strategy.value === options_js_1.STRATEGY_ALL) {
-            type = DIFFERENT;
-        }
-    }
-    return { type, oldVersion };
-}
-exports.compareVersions = compareVersions;
-//# sourceMappingURL=compare-versions.js.map

package/lib/compare-versions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compare-versions.js","sourceRoot":"","sources":["../src/compare-versions.ts"],"names":[],"mappings":";;;AAAA,mCAKgB;AAEhB,6CAA4C;AAW5C,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,SAAS,GAAG,WAAW,CAAC;AAE9B;;;;;;;GAOG;AACH,SAAgB,eAAe,CAC7B,OAAe,EACf,iBAAoC,EACpC,OAA0B;IAE1B,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,iBAAiB,CAAC;IAC5E,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAC9C,MAAM,UAAU,GAAG,IAAA,cAAW,EAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,SAAS,CAAC;IACpE,MAAM,QAAQ,GAAG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACrD,IAAI,IAA6B,CAAC;IAElC,IAAI,QAAQ,EAAE;QACZ,IAAI,CAAC,UAAU,EAAE;YACf,IAAI,GAAG,OAAO,CAAC;SAChB;aAAM,IAAI,IAAA,WAAiB,EAAC,OAAO,EAAE,UAAU,CAAC,EAAE;YACjD,IAAI,GAAG,IAAA,aAAgB,EAAC,OAAO,EAAE,UAAU,CAAC,IAAI,SAAS,CAAC;SAC3D;aAAM,IAAI,QAAQ,CAAC,KAAK,KAAK,yBAAY,EAAE;YAC1C,IAAI,GAAG,SAAS,CAAC;SAClB;KACF;IAED,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAC9B,CAAC;AAtBD,0CAsBC"}

package/lib/npm/get-publish-arguments.d.ts

@@ -1,9 +0,0 @@
-import type { NormalizedOptions } from "../normalize-options.js";
-/**
- * Given a publish configuration, get the NPM CLI publish arguments.
- *
- * @param packageSpec Package specification path.
- * @param options Publish configuration.
- * @returns Arguments to pass to the NPM CLI.
- */
-export declare function getPublishArguments(packageSpec: string, options: NormalizedOptions): string[];

package/lib/npm/get-publish-arguments.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPublishArguments = void 0;
-/**
- * Given a publish configuration, get the NPM CLI publish arguments.
- *
- * @param packageSpec Package specification path.
- * @param options Publish configuration.
- * @returns Arguments to pass to the NPM CLI.
- */
-function getPublishArguments(packageSpec, options) {
-    const { tag, access, dryRun } = options;
-    const publishArguments = [];
-    if (packageSpec.length > 0) {
-        publishArguments.push(packageSpec);
-    }
-    if (!tag.isDefault) {
-        publishArguments.push("--tag", tag.value);
-    }
-    if (!access.isDefault && access.value) {
-        publishArguments.push("--access", access.value);
-    }
-    if (dryRun.value) {
-        publishArguments.push("--dry-run");
-    }
-    return publishArguments;
-}
-exports.getPublishArguments = getPublishArguments;
-//# sourceMappingURL=get-publish-arguments.js.map

package/lib/npm/get-publish-arguments.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-publish-arguments.js","sourceRoot":"","sources":["../../src/npm/get-publish-arguments.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,WAAmB,EACnB,OAA0B;IAE1B,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1B,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACpC;IAED,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE;QAClB,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;KAC3C;IAED,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK,EAAE;QACrC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;KACjD;IAED,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACpC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAxBD,kDAwBC"}

package/src/compare-versions.ts

@@ -1,52 +0,0 @@
-import {
-  valid as semverValid,
-  gt as semverGreaterThan,
-  diff as semverDifference,
-  type ReleaseType as SemverReleaseType,
-} from "semver";
-
-import { STRATEGY_ALL } from "./options.js";
-import type { NormalizedOptions } from "./normalize-options.js";
-import type { PublishedVersions } from "./npm/index.js";
-
-export type ReleaseType = SemverReleaseType | typeof INITIAL | typeof DIFFERENT;
-
-export interface VersionComparison {
-  type: ReleaseType | undefined;
-  oldVersion: string | undefined;
-}
-
-const INITIAL = "initial";
-const DIFFERENT = "different";
-
-/**
- * Compare previously published versions with the package's current version.
- *
- * @param version The current package version.
- * @param publishedVersions The versions that have already been published.
- * @param options Configuration options
- * @returns The release type and previous version.
- */
-export function compareVersions(
-  version: string,
-  publishedVersions: PublishedVersions,
-  options: NormalizedOptions
-): VersionComparison {
-  const { versions: existingVersions, "dist-tags": tags } = publishedVersions;
-  const { strategy, tag: publishTag } = options;
-  const oldVersion = semverValid(tags[publishTag.value]) ?? undefined;
-  const isUnique = !existingVersions.includes(version);
-  let type: ReleaseType | undefined;
-
-  if (isUnique) {
-    if (!oldVersion) {
-      type = INITIAL;
-    } else if (semverGreaterThan(version, oldVersion)) {
-      type = semverDifference(version, oldVersion) ?? DIFFERENT;
-    } else if (strategy.value === STRATEGY_ALL) {
-      type = DIFFERENT;
-    }
-  }
-
-  return { type, oldVersion };
-}

package/src/npm/get-publish-arguments.ts

@@ -1,34 +0,0 @@
-import type { NormalizedOptions } from "../normalize-options.js";
-
-/**
- * Given a publish configuration, get the NPM CLI publish arguments.
- *
- * @param packageSpec Package specification path.
- * @param options Publish configuration.
- * @returns Arguments to pass to the NPM CLI.
- */
-export function getPublishArguments(
-  packageSpec: string,
-  options: NormalizedOptions
-): string[] {
-  const { tag, access, dryRun } = options;
-  const publishArguments = [];
-
-  if (packageSpec.length > 0) {
-    publishArguments.push(packageSpec);
-  }
-
-  if (!tag.isDefault) {
-    publishArguments.push("--tag", tag.value);
-  }
-
-  if (!access.isDefault && access.value) {
-    publishArguments.push("--access", access.value);
-  }
-
-  if (dryRun.value) {
-    publishArguments.push("--dry-run");
-  }
-
-  return publishArguments;
-}