@absolutejs/changelog 0.4.0 → 0.5.1

package/dist/index.d.ts

@@ -3,8 +3,8 @@ export { change, manual, moved, renamed } from "./authoring";
 export { builtSurface, changelogPaths, loadUnreleased, readJsonFile, type LoadedEntries, type LoadedEntry, } from "./entries";
 export { changesBetween, disruptiveBetween, mechanicalMigrations, migrationsBetween, parseChangelog, releasesBetween, symbolsDisturbedBetween, validateChange, type ChangeAt, type ChangelogRead, type MigrationAt, } from "./read";
 export { describeReconciliation, reconcile, type Reconciliation, type Unannounced, } from "./reconcile";
-export { isPackageName, packageArchive, packageVersions, publishedChangelog, publishedSurface, type PackageVersions, type RegistryOptions, } from "./registry";
-export { changeShape, declaresTypes, diffSurface, notable, surfaceOfArchive, surfaceOfFiles, typeEntriesOf, type ChangeShape, type PackageSurface, type SurfaceChange, type SurfaceDiff, } from "./surface";
+export { forgetRegistry, isPackageName, packageArchive, packageVersions, publishedChangelog, publishedSurface, type PackageVersions, type RegistryOptions, } from "./registry";
+export { changeShape, declaresTypes, diffSurface, notable, surfaceOfArchive, surfaceOfFiles, typeEntriesOf, type ChangeShape, type PackageSurface, type SurfaceChange, type SurfaceDiff, type SurfaceName, type TypeEntry, type Withdrawal, } from "./surface";
 export { asText, readTar, type TarLimits } from "./tarball";
 export { CHANGELOG_CONTRACT, CHANGELOG_FILE, CHANGELOG_MARKDOWN, CHANGE_KINDS, DISRUPTIVE_KINDS, isDisruptive, isMechanical, UNRELEASED_DIRECTORY, type Change, type ChangeKind, type Changelog, type DisruptiveChange, type DisruptiveKind, type Migration, type NonEmpty, type OrdinaryChange, type Release, } from "./types";
 export { compareVersions, isPrerelease, nextVersion, parseVersion, releaseKindFor, type ReleaseKind, } from "./versioning";

package/dist/index.js

@@ -410,7 +410,14 @@ var isKind = (value) => typeof value === "string" && CHANGE_KINDS.some((known) =
 var isDisruptiveKind = (kind) => kind === "breaking" || kind === "removed";
 var isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 var isText = (value) => typeof value === "string" && value.trim().length > 0;
-var textList = (value) => Array.isArray(value) && value.length > 0 && value.every(isText) ? value : undefined;
+var textList = (value, where, problems) => {
+  if (value === undefined)
+    return;
+  if (Array.isArray(value) && value.length > 0 && value.every(isText))
+    return value.filter((entry) => typeof entry === "string");
+  problems.push(`${where}: symbols is not a list of names`);
+  return;
+};
 var readMigration = (value, where, problems) => {
   if (!isRecord(value) || !isText(value.instruction)) {
     problems.push(`${where}: migration needs an instruction`);
@@ -459,7 +466,7 @@ var readChange = (value, where, problems) => {
     ...isText(value.reference) ? { reference: value.reference } : {},
     summary: value.summary
   };
-  const symbols = textList(value.symbols);
+  const symbols = textList(value.symbols, where, problems);
   const [first, ...rest] = symbols ?? [];
   if (kind === "breaking" || kind === "removed") {
     const migration = readMigration(value.migration, where, problems);
@@ -490,7 +497,8 @@ var readRelease = (value, where, problems) => {
     problems.push(`${where}: not an object`);
     return;
   }
-  if (!isText(value.version) || parseVersion(value.version) === undefined) {
+  const version = isText(value.version) ? value.version.trim() : undefined;
+  if (version === undefined || parseVersion(version) === undefined) {
     problems.push(`${where}: version is not a version`);
     return;
   }
@@ -513,7 +521,7 @@ var readRelease = (value, where, problems) => {
     changes: [head, ...tail],
     date: value.date,
     ...isText(value.note) ? { note: value.note } : {},
-    version: value.version
+    version
   };
   return release;
 };
@@ -533,7 +541,7 @@ var parseChangelog = (value) => {
     return { problems: ["not an object"] };
   if (!isText(value.name))
     problems.push("needs a package name");
-  if (typeof value.contract !== "number" || value.contract > CHANGELOG_CONTRACT)
+  if (!Number.isInteger(value.contract) || Number(value.contract) > CHANGELOG_CONTRACT)
     problems.push(`contract ${JSON.stringify(value.contract)} is newer than ${CHANGELOG_CONTRACT}, which this reader understands`);
   const raw = value.releases;
   if (!Array.isArray(raw))
@@ -735,33 +743,55 @@ var surfaceOfArchive = (archive) => {
 };
 var surfaceOfFiles = (files, entries) => {
   const surface = new Map;
-  for (const entry of entries)
-    for (const [name, text] of exportsOf(files, entry, new Set))
-      if (!surface.has(name))
-        surface.set(name, text);
+  const offered = entries.flatMap((entry) => [...exportsOf(files, entry.path, new Set)].map(([name, declaration]) => ({ declaration, name, specifier: entry.specifier })));
+  for (const { declaration, name, specifier } of offered) {
+    const known = surface.get(name);
+    if (known === undefined)
+      surface.set(name, { declaration, entries: [specifier] });
+    else if (!known.entries.includes(specifier))
+      known.entries.push(specifier);
+  }
+  for (const value of surface.values())
+    value.entries.sort();
   return surface;
 };
-var typeCandidatesIn = (value) => {
+var exportEntries = (value, packageName, specifier) => {
+  const here = specifier ?? packageName;
   if (typeof value === "string")
-    return [value];
+    return [{ specifier: here, value }];
   if (typeof value !== "object" || value === null)
     return [];
-  return Object.entries(value).flatMap(([key, nested]) => key === "types" || key === "typings" ? typeCandidatesIn(nested) : typeCandidatesIn(nested));
+  return Object.entries(value).flatMap(([key, nested]) => key.startsWith(".") ? exportEntries(nested, packageName, key === "." ? packageName : `${packageName}${key.slice(1)}`) : exportEntries(nested, packageName, here));
 };
 var typeEntriesOf = (manifest, files) => {
   const record = typeof manifest === "object" && manifest !== null ? new Map(Object.entries(manifest)) : new Map;
-  const claimed = [
-    record.get("types"),
-    record.get("typings"),
-    ...typeCandidatesIn(record.get("exports"))
+  const named = record.get("name");
+  const packageName = typeof named === "string" ? named : "";
+  const resolved = (value, specifier) => {
+    if (typeof value !== "string")
+      return [];
+    const cleaned = value.replace(/^\.\//u, "");
+    const candidates = DECLARATION.test(cleaned) ? [cleaned] : [
+      cleaned.replace(/\.[cm]?js$/u, ".d.ts"),
+      cleaned.replace(/\.[cm]?js$/u, ".d.mts"),
+      cleaned.replace(/\.[cm]?js$/u, ".d.cts")
+    ];
+    return candidates.filter((candidate) => files.has(candidate)).map((resolvedPath) => ({ path: resolvedPath, specifier }));
+  };
+  const found = [
+    ...resolved(record.get("types"), packageName),
+    ...resolved(record.get("typings"), packageName),
+    ...exportEntries(record.get("exports"), packageName).flatMap((entry) => resolved(entry.value, entry.specifier))
   ];
-  const entries = claimed.filter((value) => typeof value === "string").map((value) => value.replace(/^\.\//u, "")).flatMap((cleaned) => DECLARATION.test(cleaned) ? [cleaned] : [
-    cleaned.replace(/\.[cm]?js$/u, ".d.ts"),
-    cleaned.replace(/\.[cm]?js$/u, ".d.mts"),
-    cleaned.replace(/\.[cm]?js$/u, ".d.cts")
-  ]).filter((candidate) => files.has(candidate));
-  const fallback = entries.length === 0 && files.has("dist/index.d.ts") ? ["dist/index.d.ts"] : [];
-  return [...new Set([...entries, ...fallback])];
+  const fallback = found.length === 0 && files.has("dist/index.d.ts") ? [{ path: "dist/index.d.ts", specifier: packageName }] : [];
+  const seen = new Set;
+  return [...found, ...fallback].filter((entry) => {
+    const key = `${entry.specifier}\x00${entry.path}`;
+    if (seen.has(key))
+      return false;
+    seen.add(key);
+    return true;
+  });
 };
 var SHAPE = {
   members: "members",
@@ -816,23 +846,33 @@ var changeShape = (change2) => {
 };
 var diffSurface = (before, after) => {
   const removed = [];
+  const withdrawn = [];
   const changed = [];
-  for (const [name, declaration] of before) {
+  for (const [name, was] of before) {
     const now = after.get(name);
     if (now === undefined)
       removed.push(name);
-    else if (now !== declaration)
+    if (now === undefined)
+      continue;
+    const lost = was.entries.filter((entry) => !now.entries.includes(entry));
+    if (lost.length > 0)
+      withdrawn.push({ from: lost, name });
+    if (now.declaration !== was.declaration)
       changed.push({
-        after: now,
-        before: declaration,
+        after: now.declaration,
+        before: was.declaration,
         name,
-        shape: changeShape({ after: now, before: declaration })
+        shape: changeShape({
+          after: now.declaration,
+          before: was.declaration
+        })
       });
   }
   return {
     added: [...after.keys()].filter((name) => !before.has(name)),
     changed,
-    removed
+    removed,
+    withdrawn
   };
 };
 var notable = (diff) => diff.changed.filter((change2) => change2.shape === "parameters" || change2.shape === "members");
@@ -955,10 +995,11 @@ var describeReconciliation = (found) => {
     members: "changed the members of its type",
     parameters: "changed what it is called with",
     removed: "is no longer exported",
-    types: "changed its declaration"
+    types: "changed its declaration",
+    withdrawn: "is no longer exported from"
   };
   for (const entry of found.unannounced)
-    lines.push(`\`${entry.name}\` ${moved2[entry.kind]} and no entry says so`);
+    lines.push(entry.kind === "withdrawn" ? `\`${entry.name}\` ${moved2.withdrawn} ${(entry.from ?? []).join(", ")} and no entry says so` : `\`${entry.name}\` ${moved2[entry.kind]} and no entry says so`);
   for (const name of found.unknownSymbols)
     lines.push(`an entry names \`${name}\`, which this package does not export`);
   lines.push(...found.wrongMigrations);
@@ -969,6 +1010,7 @@ var reconcile = (input) => {
   const mentioned = new Set(input.changes.flatMap((change2) => [...change2.symbols ?? []]));
   const unannounced = [
     ...input.diff.removed.filter((name) => !disruptive.has(name)).map((name) => ({ kind: "removed", name })),
+    ...input.diff.withdrawn.filter((entry) => !disruptive.has(entry.name)).map((entry) => ({ from: entry.from, kind: "withdrawn", name: entry.name })),
     ...input.diff.changed.filter((change2) => !mentioned.has(change2.name) && change2.shape !== "unknown").map((change2) => ({ kind: change2.shape, name: change2.name }))
   ];
   const unknownSymbols = [
@@ -993,6 +1035,8 @@ var MAX_ARCHIVE_BYTES = MAX_ARCHIVE_MEBIBYTES * MEBIBYTE2;
 var MAX_DOWNLOAD_MEBIBYTES = 32;
 var MAX_DOWNLOAD_BYTES = MAX_DOWNLOAD_MEBIBYTES * MEBIBYTE2;
 var TIMEOUT_MS = 20000;
+var NOT_FOUND = 404;
+var NOTHING_PUBLISHED = { published: [], tarballs: {} };
 var PACKAGE_NAME = /^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/u;
 var MAX_NAME_LENGTH = 214;
 var isPackageName = (name) => name.length <= MAX_NAME_LENGTH && PACKAGE_NAME.test(name);
@@ -1036,9 +1080,25 @@ var packageArchive = async (name, version, options = {}) => {
     return;
   }
 };
+var packuments = new Map;
+var SECONDS_PER_MINUTE = 60;
+var MILLISECONDS_PER_SECOND = 1000;
+var PACKUMENT_MINUTES = 5;
+var PACKUMENT_TTL_MS = PACKUMENT_MINUTES * SECONDS_PER_MINUTE * MILLISECONDS_PER_SECOND;
+var forgetRegistry = () => packuments.clear();
 var packageVersions = async (name, options = {}) => {
   if (!isPackageName(name))
     return;
+  const cacheable = options.fetch === undefined && options.registry === undefined;
+  const known = cacheable ? packuments.get(name) : undefined;
+  if (known !== undefined && Date.now() - known.asked < PACKUMENT_TTL_MS)
+    return known.value;
+  const value = askRegistry(name, options);
+  if (cacheable)
+    packuments.set(name, { asked: Date.now(), value });
+  return value;
+};
+var askRegistry = async (name, options) => {
   const call = options.fetch ?? fetch;
   const url = `${options.registry ?? DEFAULT_REGISTRY}/${name.replace("/", "%2f")}`;
   try {
@@ -1047,9 +1107,9 @@ var packageVersions = async (name, options = {}) => {
       signal: AbortSignal.timeout(TIMEOUT_MS)
     });
     const response = abbreviated.ok ? abbreviated : await call(url, { signal: AbortSignal.timeout(TIMEOUT_MS) });
-    if (!response.ok)
-      return;
-    return readPackument(await response.json());
+    if (response.ok)
+      return readPackument(await response.json());
+    return response.status === NOT_FOUND ? NOTHING_PUBLISHED : undefined;
   } catch {
     return;
   }
@@ -1196,6 +1256,7 @@ export {
   describeReconciliation,
   diffSurface,
   disruptiveBetween,
+  forgetRegistry,
   isDisruptive,
   isMechanical,
   isPackageName,
@@ -1228,5 +1289,5 @@ export {
   validateChange
 };
 
-//# debugId=7DC9C4F3C075733D64756E2164756E21
+//# debugId=C07818292D22AD6164756E2164756E21
 //# sourceMappingURL=index.js.map