@defold-typescript/types 0.36.0 → 0.37.0

package/generated/versions/defold-1.13.0/b2d_shape.d.ts

@@ -202,10 +202,12 @@ declare global {
      * @example
      * ```ts
      * const body = b2d.get_body("#collisionobject");
-     * const circle = b2d.shape.get_shape(body, 1);
-     * circle.center = vmath.vector3(24, 0, 0);
-     * b2d.shape.set_shape(body, 1, circle, true);
-     * b2d.shape.set_shape(body, 2, { type: b2d.shape.SHAPE_TYPE_SEGMENT, v1: vmath.vector3(-32, 0, 0), v2: vmath.vector3(32, 0, 0) });
+     * if (body !== undefined) {
+     *   const circle = b2d.shape.get_shape(body, 1);
+     *   circle.center = vmath.vector3(24, 0, 0);
+     *   b2d.shape.set_shape(body, 1, circle, true);
+     *   b2d.shape.set_shape(body, 2, { type: b2d.shape.SHAPE_TYPE_SEGMENT, v1: vmath.vector3(-32, 0, 0), v2: vmath.vector3(32, 0, 0) });
+     * }
      * ```
      */
     function set_shape(shape_id: Opaque<"b2Shape">, definition: { type?: number; radius?: number; center?: Vector3; v0?: Vector3; v1?: Vector3; v2?: Vector3; v3?: Vector3; vertices?: Vector3[]; hx?: number; hy?: number; angle?: number; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 }, update_mass: boolean): void;

package/generated/versions/defold-1.13.0/resource.d.ts

@@ -844,7 +844,7 @@ declare global {
      *     // the info table contains meta data about all the render target attachments
      *     // so it's not necessary to use resource.get_texture here, but we do it here
      *     // just to show that it's possible:
-     *     const info_attachment_1 = resource.get_texture_info(info.attachments[0].handle);
+     *     const info_attachment_1 = resource.get_texture_info(info.attachments[0]!.handle);
      *   },
      * });
      *
@@ -852,7 +852,7 @@ declare global {
      * export default defineScript({
      *   init() {
      *     const info = resource.get_render_target_info("/my_render_target.render_targetc");
-     *     const attachment = info.attachments[0].texture;
+     *     const attachment = info.attachments[0]!.texture!;
      *     // you can also get texture info from the 'texture' field, since it's a resource hash
      *     const texture_info = resource.get_texture_info(attachment);
      *     go.set("#model", "texture0", attachment);
@@ -860,7 +860,7 @@ declare global {
      * });
      * ```
      */
-    function get_render_target_info(path: Hash | string | number): { handle: number; width: number; height: number; depth: number; mipmaps: number; type: number; buffer_type: number; texture: Hash };
+    function get_render_target_info(path: Hash | string | number): { handle: number; attachments: { handle: number; width: number; height: number; depth: number; mipmaps: number; type: number; buffer_type: number; texture?: Hash }[] };
     /**
      * Gets the text metrics from a font
      *
@@ -1051,7 +1051,7 @@ declare global {
      * export default defineScript({
      *   init(self) {
      *     const rt_info = resource.get_render_target_info(self.my_render_target);
-     *     go.set("#model", "texture0", rt_info.attachments[0].texture);
+     *     go.set("#model", "texture0", rt_info.attachments[0]!.texture!);
      *   },
      * });
      * ```

package/generated/versions/defold-1.13.0/sys.d.ts

@@ -294,7 +294,7 @@ declare global {
      * }
      * ```
      */
-    function get_ifaddrs(): { name: string; address: string; mac: string; up: boolean; running: boolean }[];
+    function get_ifaddrs(): { name: string; address?: string; mac?: string; up: boolean; running: boolean }[];
     /**
      * The save-file path is operating system specific and is typically located under the user's home directory.
      * This function will raise a Lua error if unable to get the save file path.
@@ -365,7 +365,7 @@ declare global {
      * }
      * ```
      */
-    function get_sys_info(options?: { ignore_secure?: boolean }): { device_model: string; manufacturer: string; system_name: string; system_version: string; api_version: string; language: string; device_language: string; territory: string; gmt_offset: number; device_ident: string; user_agent: string };
+    function get_sys_info(options?: { ignore_secure?: boolean }): { device_model?: string; manufacturer?: string; system_name: string; system_version: string; api_version: string; language: string; device_language: string; territory: string; gmt_offset: number; device_ident?: string; user_agent?: string };
     /**
      * If the file exists, it must have been created by `sys.save` to be loaded.
      * This function will raise a Lua error if an error occurs while loading the file.

package/generated/versions/defold-1.13.0/window.d.ts

@@ -95,7 +95,7 @@ declare global {
      *
      * - number `inset_bottom`
      */
-    function get_safe_area(): { safe_area: { x: number; y: number; width: number; height: number; inset_left: number; inset_top: number; inset_right: number; inset_bottom: number } };
+    function get_safe_area(): { x: number; y: number; width: number; height: number; inset_left: number; inset_top: number; inset_right: number; inset_bottom: number };
     /**
      * This returns the current window size (width and height).
      */

package/generated/window.d.ts

@@ -95,7 +95,7 @@ declare global {
      *
      * - number `inset_bottom`
      */
-    function get_safe_area(): { safe_area: { x: number; y: number; width: number; height: number; inset_left: number; inset_top: number; inset_right: number; inset_bottom: number } };
+    function get_safe_area(): { x: number; y: number; width: number; height: number; inset_left: number; inset_top: number; inset_right: number; inset_bottom: number };
     /**
      * This returns the current window size (width and height).
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defold-typescript/types",
-  "version": "0.36.0",
+  "version": "0.37.0",
   "description": "TypeScript types for the Defold engine's Lua APIs.",
   "license": "MIT",
   "repository": {

package/src/emit-dts.ts

@@ -245,6 +245,32 @@ export const RETURN_TYPE_OVERRIDES: ReadonlyMap<string, string> = new Map([
   ["editor.tx.add", 'Opaque<"transaction_step">'],
 ]);
 
+// A function whose `returnvalues` declare a concrete type while the same slot's
+// prose documents a `nil` alternative. Distinct from RETURN_TYPE_OVERRIDES
+// above, which fills an *empty* `returnvalues`: these contradict a token
+// upstream explicitly declares, so each entry records it and
+// `return-correction-provenance.test.ts` pins it against every vendored
+// ref-doc. Upstream adding `nil` to `types` hands the case to the top-level
+// `nil` projection in `mapSlotUnion` and reds the entry, which is then deleted
+// rather than re-pinned.
+export interface ReturnTypeCorrection {
+  readonly ts: string;
+  readonly upstream: readonly string[];
+  readonly reason: string;
+}
+
+// Keyed by FQN, mirroring PROPERTY_TYPE_CORRECTIONS.
+export const RETURN_TYPE_CORRECTIONS: ReadonlyMap<string, ReturnTypeCorrection> = new Map([
+  [
+    "b2d.get_body",
+    {
+      ts: 'Opaque<"b2Body"> | undefined',
+      upstream: ["b2Body"],
+      reason: "the body if successful. Otherwise nil.",
+    },
+  ],
+]);
+
 // A property whose upstream `<span class="type">` states a type the engine does
 // not use. Unlike every other override here, which fills a gap upstream left
 // empty, these contradict a token upstream explicitly declares — so each entry
@@ -819,6 +845,38 @@ export const TABLE_SLOT_CURATIONS: ReadonlyMap<string, TableSlotCuration> = new
       ],
     },
   ],
+  // resource.get_render_target_info's return `<dl>` writes one key as
+  // `<dt>'attachments'</dt>` — quoted rather than wrapped in `<code>` — so
+  // TABLE_FIELD drops it and parseTableFields hoists the seven per-attachment
+  // fields to the top level, contradicting the `info.attachments[0].handle`
+  // access in the doc's own `@example`. Same shape and same remedy as
+  // font.get_info:return:info above: replace the mis-parsed field list with the
+  // faithful nested isList object. `texture` is documented "only available if
+  // the render target passed in is a resource", hence optional.
+  [
+    "resource.get_render_target_info:return:table",
+    {
+      kind: "object",
+      fields: [
+        { name: "handle", types: ["number"] },
+        {
+          name: "attachments",
+          types: ["table"],
+          isList: true,
+          fields: [
+            { name: "handle", types: ["number"] },
+            { name: "width", types: ["number"] },
+            { name: "height", types: ["number"] },
+            { name: "depth", types: ["number"] },
+            { name: "mipmaps", types: ["number"] },
+            { name: "type", types: ["number"] },
+            { name: "buffer_type", types: ["number"] },
+            { name: "texture", types: ["hash"], optional: true },
+          ],
+        },
+      ],
+    },
+  ],
   // profiler.view_recorded_frame's `frame_index` is a typed `<ul>` "specify one
   // of the following": `distance` and `frame`, both numeric frame offsets. The
   // <li> items carry no `<span class="type">`, so parseTableFields recovers
@@ -1369,6 +1427,95 @@ export const TABLE_FIELD_TYPE_OVERRIDES: ReadonlyMap<string, string> = new Map([
   ["material.get_vertex_attributes:return:table:value", ATTRIBUTE_VALUE_TS],
 ]);
 
+// A return-slot field upstream documents as platform-gated or nil-valued while
+// declaring it like any other. Lua removes a key assigned `nil`, so "might be
+// nil if not available" and "only available on iOS and Android" describe the
+// same runtime state — the key is absent — and the correction is always `?`,
+// never a required field widened to `| undefined`.
+//
+// Separate from TABLE_FIELD_TYPE_OVERRIDES because presence is the other axis:
+// the parser reads these fields' types correctly and stays authoritative for
+// them, so an entry here restates no type and cannot drift when upstream
+// retypes a field. `upstream` is pinned rather than consumed, and `evidence` is
+// the decoded prose `return-correction-provenance.test.ts` searches the slot doc
+// for; both red the entry once upstream marks the field or drops the gate.
+//
+// Keyed `<element>:<kind>:<slot>:<field>`, the TABLE_FIELD_TYPE_OVERRIDES shape.
+export interface ReturnFieldOptionalityCorrection {
+  readonly upstream: readonly string[];
+  readonly evidence: string;
+}
+
+// The platform-gate markers upstream renders as `<span class="icon-*">` decode
+// to `[ios]`, `[android]`, `[html5]` — `user_agent` states its gate through the
+// marker alone, with no availability sentence to pin.
+export const RETURN_FIELD_OPTIONALITY_CORRECTIONS: ReadonlyMap<
+  string,
+  ReturnFieldOptionalityCorrection
+> = new Map([
+  [
+    "sys.get_sys_info:return:sys_info:device_model",
+    { upstream: ["string"], evidence: "[ios][android] Only available on iOS and Android." },
+  ],
+  [
+    "sys.get_sys_info:return:sys_info:manufacturer",
+    { upstream: ["string"], evidence: "[ios][android] Only available on iOS and Android." },
+  ],
+  [
+    "sys.get_sys_info:return:sys_info:device_ident",
+    {
+      upstream: ["string"],
+      evidence: '[ios] "identifierForVendor" on iOS. [android] "android_id" on Android.',
+    },
+  ],
+  [
+    "sys.get_sys_info:return:sys_info:user_agent",
+    { upstream: ["string"], evidence: "[html5] The HTTP user agent" },
+  ],
+  [
+    "sys.get_ifaddrs:return:ifaddrs:address",
+    { upstream: ["string"], evidence: "might be nil if not available." },
+  ],
+  [
+    "sys.get_ifaddrs:return:ifaddrs:mac",
+    { upstream: ["string"], evidence: "might be nil if not available." },
+  ],
+]);
+
+// Mark a parser-recovered field optional from RETURN_FIELD_OPTIONALITY_CORRECTIONS,
+// leaving every other field — and every field's type — untouched. Sets the
+// `optional` flag `TableField` already carries and `inlineTableType` already
+// reads, so no `mapType` is needed and no correction can change a type.
+//
+// A correction keyed to this slot that matches no recovered field throws rather
+// than no-opping: a field upstream renamed would otherwise leave a stale entry
+// looking applied while the emitted declaration silently re-widened.
+// Returns a new array; never mutates the parser's result.
+export function applyFieldOptionalityCorrections(
+  elementName: string,
+  slotKind: "param" | "return" | undefined,
+  slotName: string | undefined,
+  fields: readonly TableField[],
+): TableField[] {
+  if (slotKind === undefined || slotName === undefined) return [...fields];
+  const prefix = `${tableSlotKey(elementName, slotKind, slotName)}:`;
+  const corrected = fields.map((field) =>
+    RETURN_FIELD_OPTIONALITY_CORRECTIONS.has(`${prefix}${field.name}`)
+      ? { ...field, optional: true }
+      : field,
+  );
+  const recovered = new Set(fields.map((field) => field.name));
+  const stale = [...RETURN_FIELD_OPTIONALITY_CORRECTIONS.keys()].filter(
+    (key) => key.startsWith(prefix) && !recovered.has(key.slice(prefix.length)),
+  );
+  if (stale.length > 0) {
+    throw new Error(
+      `field-optionality correction names no recovered field: ${stale.sort().join(", ")}`,
+    );
+  }
+  return corrected;
+}
+
 // Pin a parser-recovered field's TS type from TABLE_FIELD_TYPE_OVERRIDES,
 // leaving every other field parser-authoritative. A field the override does not
 // name is returned unchanged; a field it names gains a `tsType` (emitted
@@ -1605,7 +1752,11 @@ export function buildTableDocResolver(sources: readonly TableDocSource[]): Table
   return (elementName) => docByName.get(elementName);
 }
 
-export function parseTableFields(doc: string, resolver?: TableDocResolver): TableField[] | null {
+export function parseTableFields(
+  doc: string,
+  resolver?: TableDocResolver,
+  slotName?: string,
+): TableField[] | null {
   const fields: TableField[] = [];
   for (const match of doc.matchAll(TABLE_FIELD)) {
     const name = (match[1] ?? "").trim();
@@ -1624,14 +1775,20 @@ export function parseTableFields(doc: string, resolver?: TableDocResolver): Tabl
   }
   // Nested recovery, scoped to the one unambiguous shape: a `<dl>` declaring a
   // single `table`-typed field whose keys sit in an immediately-following
-  // top-level `<ul>` typed-field list (`window.get_safe_area`). Attach the
-  // `<ul>` fields as that field's nested shape so the slot recovers as a nested
-  // object instead of a `Record`.
+  // top-level `<ul>` typed-field list. Attach the `<ul>` fields as that field's
+  // nested shape so the slot recovers as a nested object instead of a `Record`.
+  //
+  // Unless the header restates the slot it describes (`window.get_safe_area`'s
+  // `safe_area` return documented under a `safe_area` header): that is a
+  // restatement, not a nesting level, and wrapping it emits a level the engine
+  // never returns. Only a caller that knows the slot name can tell the two
+  // apart, so the `<ul>` keys are returned directly when they match.
   if (fields.length === 1) {
     const only = fields[0];
     if (only && only.types.length === 1 && only.types[0] === "table") {
       const nested = parseUlFields(doc);
       if (nested.length > 0) {
+        if (slotName !== undefined && slotName === only.name) return nested;
         only.fields = nested;
         return [only];
       }
@@ -2586,6 +2743,10 @@ function emitReturn(
   // slots and leaves the consumer on its token-derived fallback.
   const override = RETURN_TYPE_OVERRIDES.get(elementName);
   if (override !== undefined) return { type: override, trailing: "", slots: [] };
+  // Kept beside the override lookup so the two stay visibly distinct: this one
+  // contradicts a declared token rather than filling an empty `returnvalues`,
+  // and it is a per-slot render, so it reports its slot.
+  const correction = RETURN_TYPE_CORRECTIONS.get(elementName);
   if (returnValues.length === 0) return { type: "void", trailing: "", slots: [] };
   if (returnValues.length > 1) {
     // Defold multi-returns are positional and always present; each slot maps
@@ -2617,6 +2778,13 @@ function emitReturn(
   }
   const first = returnValues[0];
   if (!first) return { type: "void", trailing: "", slots: [] };
+  if (correction !== undefined) {
+    return {
+      type: correction.ts,
+      trailing: "",
+      slots: [{ position: 0, name: first.name, ts: correction.ts }],
+    };
+  }
   const ts =
     first.types.length > 0
       ? mapSlotUnion(
@@ -2727,19 +2895,25 @@ function mapSlotUnion(
         // arbitrary name. Reusing the parser keeps the inner fields in lockstep
         // with the doc instead of a hand-listed drift-prone copy; a documented
         // array-form field is pinned via TABLE_FIELD_TYPE_OVERRIDES.
-        const parsed = applyFieldTypeOverrides(
+        const parsed = applyFieldOptionalityCorrections(
           elementName,
           slotKind,
           slotName,
-          parseTableFields(doc, resolver) ?? [],
+          applyFieldTypeOverrides(
+            elementName,
+            slotKind,
+            slotName,
+            parseTableFields(doc, resolver, slotName) ?? [],
+          ),
         );
         const object = inlineTableType(parsed, mapType, optionalFields);
         ts = `Record<string, ${object}>`;
       } else {
-        const parsed = parseTableFields(doc, resolver);
+        const parsed = parseTableFields(doc, resolver, slotName);
         if (parsed !== null) {
           const nested = applyNestedFieldCurations(elementName, slotKind, slotName, parsed);
-          const fields = applyFieldTypeOverrides(elementName, slotKind, slotName, nested);
+          const typed = applyFieldTypeOverrides(elementName, slotKind, slotName, nested);
+          const fields = applyFieldOptionalityCorrections(elementName, slotKind, slotName, typed);
           const object = inlineTableType(fields, mapType, optionalFields);
           ts = isSlotLevelList(doc) ? `${object}[]` : object;
         } else {

package/src/return-correction-provenance.ts

@@ -0,0 +1,306 @@
+// Provenance helpers for the two return-side correction tables. Both read the
+// vendored ref-doc as text rather than through `parseDefoldApiDoc`, because the
+// evidence a return-side correction rests on lives in the slot's HTML prose and
+// the parser discards it.
+
+import type { ReturnFieldOptionalityCorrection, ReturnTypeCorrection } from "./emit-dts";
+import type { ProvenanceSurface } from "./optional-correction-provenance";
+
+const NAMED_ENTITIES: Record<string, string> = {
+  "&lt;": "<",
+  "&gt;": ">",
+  "&quot;": '"',
+  "&#39;": "'",
+  "&apos;": "'",
+};
+
+function decodeEntities(text: string): string {
+  let out = text;
+  for (const [entity, char] of Object.entries(NAMED_ENTITIES)) {
+    out = out.split(entity).join(char);
+  }
+  out = out.replace(/&#(\d+);/g, (_, code) => String.fromCharCode(Number(code)));
+  // `&amp;` last so an already-decoded `&` is never re-interpreted.
+  return out.split("&amp;").join("&");
+}
+
+/**
+ * Decode a ref-doc prose fragment to the plain text a correction's `evidence`
+ * string is matched against.
+ *
+ * Unlike `htmlToDocText`, a `<span class="icon-X">` marker survives as `[X]`.
+ * Upstream states some field-presence gates only through that marker —
+ * `user_agent` carries `icon-html5` and no availability sentence at all — so
+ * stripping it would leave those corrections pinned to prose that says nothing
+ * about presence, and an upstream fix removing the gate would not red them.
+ */
+export function decodeSlotProse(html: string): string {
+  const withIcons = html.replace(
+    /<span class="icon-([a-z0-9-]+)"><\/span>/gi,
+    (_, platform: string) => `[${platform}]`,
+  );
+  return decodeEntities(withIcons.replace(/<[^>]+>/g, ""))
+    .replace(/[ \t]+/g, " ")
+    .replace(/ *\n */g, "\n")
+    .trim();
+}
+
+/**
+ * The decoded prose of one `<dd>` in a slot doc's `<dl>`, keyed by the `<dt>`
+ * field name. Returns `undefined` when the slot doc has no entry for the field,
+ * which is the signal that upstream renamed or dropped it.
+ */
+export function fieldProse(slotDoc: string, field: string): string | undefined {
+  const escaped = field.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  const match = new RegExp(`<dt><code>${escaped}</code></dt>\\s*<dd>([\\s\\S]*?)</dd>`, "i").exec(
+    slotDoc,
+  );
+  return match?.[1] === undefined ? undefined : decodeSlotProse(match[1]);
+}
+
+/**
+ * The `<span class="type">` tokens upstream declares for one `<dd>`, split the
+ * way the table-field parser splits them. An absent field yields `undefined`;
+ * a field with no type span yields an empty array.
+ */
+export function fieldTypeTokens(slotDoc: string, field: string): readonly string[] | undefined {
+  const escaped = field.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  const match = new RegExp(`<dt><code>${escaped}</code></dt>\\s*<dd>([\\s\\S]*?)</dd>`, "i").exec(
+    slotDoc,
+  );
+  if (match?.[1] === undefined) return undefined;
+  const span = /<span class="type">([^<]*)<\/span>/.exec(match[1]);
+  if (span?.[1] === undefined) return [];
+  return span[1]
+    .split("|")
+    .map((token) => token.trim())
+    .filter((token) => token.length > 0);
+}
+
+interface RawSlot {
+  readonly name?: string;
+  readonly doc?: string;
+  readonly types?: readonly string[];
+}
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+// Every `returnvalues` entry of every FUNCTION in the surface named `element`,
+// unfiltered by slot: one target can declare the element more than once.
+function returnSlots(doc: unknown, element: string): RawSlot[] {
+  if (!isRecord(doc) || !Array.isArray(doc.elements)) return [];
+  return doc.elements.flatMap((candidate) =>
+    isRecord(candidate) &&
+    candidate.type === "FUNCTION" &&
+    candidate.name === element &&
+    Array.isArray(candidate.returnvalues)
+      ? candidate.returnvalues.filter(isRecord)
+      : [],
+  );
+}
+
+// The first `returnvalues` entry of each declaration of `element`, one per
+// declaration so a target that declares the element twice is folded, not sliced.
+function firstReturnSlots(doc: unknown, element: string): RawSlot[] {
+  if (!isRecord(doc) || !Array.isArray(doc.elements)) return [];
+  return doc.elements.flatMap((candidate) => {
+    if (
+      !isRecord(candidate) ||
+      candidate.type !== "FUNCTION" ||
+      candidate.name !== element ||
+      !Array.isArray(candidate.returnvalues)
+    ) {
+      return [];
+    }
+    const first = candidate.returnvalues[0];
+    return isRecord(first) ? [first] : [];
+  });
+}
+
+function namespaceOf(element: string): string {
+  return element.slice(0, element.lastIndexOf("."));
+}
+
+// A sighted target lands in exactly one bucket, strongest signal first. A
+// dropped field outranks a needed one because `applyFieldOptionalityCorrections`
+// throws for that target, so regen fails there whatever the other declarations
+// say; a needed one outranks a resolved one so an overload that still shows the
+// defect keeps the correction alive, matching `correctionProvenance`.
+type FieldVerdict = "missing" | "needed" | "resolved";
+
+const FIELD_VERDICT_RANK: Record<FieldVerdict, number> = {
+  missing: 2,
+  needed: 1,
+  resolved: 0,
+};
+
+export interface ReturnFieldProvenance {
+  readonly key: string;
+  readonly sightedIn: readonly string[];
+  readonly neededBy: readonly string[];
+  readonly resolvedIn: readonly string[];
+  readonly missingFieldIn: readonly string[];
+  readonly typeDrift: readonly string[];
+}
+
+// Upstream sets no structural optionality flag on a return *field* — the parser
+// never populates `TableField.optional`, only the curation and correction passes
+// do — so there is no `isMarkedOptional` analogue to read here. "Resolved" is
+// therefore prose- and token-shaped: the evidence sentence is gone from the
+// field's `<dd>`, or its type span now declares `nil` itself.
+//
+// `missingFieldIn` is deliberately not a resolution. A field upstream dropped
+// from a slot the target still declares makes the correction stale, and
+// `applyFieldOptionalityCorrections` throws rather than no-op for it, so that
+// target needs a human decision instead of a silent deletion.
+export function fieldCorrectionProvenance(
+  entries: readonly [string, ReturnFieldOptionalityCorrection][],
+  surfaces: readonly ProvenanceSurface[],
+): ReturnFieldProvenance[] {
+  return entries.map(([key, correction]) => {
+    const parts = key.split(":");
+    if (parts.length !== 4) {
+      throw new Error(`fieldCorrectionProvenance: malformed key ${key}`);
+    }
+    const [element, , slotName, field] = parts as [string, string, string, string];
+    const namespace = namespaceOf(element);
+
+    const verdicts = new Map<string, FieldVerdict>();
+    const drift = new Map<string, Set<string>>();
+    for (const surface of surfaces) {
+      if (surface.namespace !== namespace) continue;
+      for (const slot of returnSlots(surface.doc, element)) {
+        if (slot.name !== slotName) continue;
+        const slotDoc = slot.doc ?? "";
+        const prose = fieldProse(slotDoc, field);
+        const tokens = fieldTypeTokens(slotDoc, field);
+
+        let verdict: FieldVerdict;
+        if (prose === undefined) {
+          verdict = "missing";
+        } else if (!prose.includes(correction.evidence) || (tokens ?? []).includes("nil")) {
+          verdict = "resolved";
+        } else {
+          verdict = "needed";
+          if ((tokens ?? []).join("|") !== correction.upstream.join("|")) {
+            const messages = drift.get(surface.target) ?? new Set<string>();
+            drift.set(surface.target, messages);
+            messages.add(
+              `${surface.target}: pinned ${correction.upstream.join("|")}, found ${tokens?.join("|") ?? "no field"}`,
+            );
+          }
+        }
+
+        const seen = verdicts.get(surface.target);
+        if (seen === undefined || FIELD_VERDICT_RANK[verdict] > FIELD_VERDICT_RANK[seen]) {
+          verdicts.set(surface.target, verdict);
+        }
+      }
+    }
+
+    const sightedIn = [...verdicts.keys()].sort();
+    const inBucket = (verdict: FieldVerdict) =>
+      sightedIn.filter((target) => verdicts.get(target) === verdict);
+    const neededBy = inBucket("needed");
+    return {
+      key,
+      sightedIn,
+      neededBy,
+      resolvedIn: inBucket("resolved"),
+      missingFieldIn: inBucket("missing"),
+      typeDrift: neededBy.flatMap((target) => [...(drift.get(target) ?? [])]).sort(),
+    };
+  });
+}
+
+export interface ReturnTypeProvenance {
+  readonly key: string;
+  readonly sightedIn: readonly string[];
+  readonly neededBy: readonly string[];
+  readonly resolvedIn: readonly string[];
+  readonly driftedIn: readonly string[];
+  readonly typeDrift: readonly string[];
+}
+
+// Same ranking argument as `FIELD_VERDICT_RANK`: `emitReturn` applies the
+// correction to every declaration of the FQN in a target, so one drifted
+// declaration makes that target's emit wrong whatever its siblings say.
+type ReturnVerdict = "drift" | "needed" | "resolved";
+
+const RETURN_VERDICT_RANK: Record<ReturnVerdict, number> = {
+  drift: 2,
+  needed: 1,
+  resolved: 0,
+};
+
+function baseTokens(tokens: readonly string[]): string {
+  return tokens.filter((token) => token !== "nil").join("|");
+}
+
+// The return-type class has the same two-sided evidence: the declared tokens
+// still say what the correction contradicts, and the slot prose still states the
+// contradiction. A target that fixes either half no longer needs the entry.
+//
+// Unlike the field lane, a changed base type is drift here rather than a
+// resolution. A field correction only flips `optional` and leaves the type
+// parser-authoritative, so a retyped field still emits what upstream declares; a
+// return correction replaces the whole emitted type, so a base upstream no longer
+// declares means the correction now overwrites a type nobody verified — a
+// decision for a human, not a deletion and not a silent bank.
+export function returnCorrectionProvenance(
+  entries: readonly [string, ReturnTypeCorrection][],
+  surfaces: readonly ProvenanceSurface[],
+): ReturnTypeProvenance[] {
+  return entries.map(([key, correction]) => {
+    const namespace = namespaceOf(key);
+    const pinned = baseTokens(correction.upstream);
+
+    const verdicts = new Map<string, ReturnVerdict>();
+    const drift = new Map<string, Set<string>>();
+    for (const surface of surfaces) {
+      if (surface.namespace !== namespace) continue;
+      // The correction rewrites the first return only, so only that slot is
+      // evidence; a declaration with no returns at all sights nothing.
+      for (const slot of firstReturnSlots(surface.doc, key)) {
+        const tokens = slot.types ?? [];
+
+        let verdict: ReturnVerdict;
+        if (baseTokens(tokens) !== pinned) {
+          verdict = "drift";
+          const messages = drift.get(surface.target) ?? new Set<string>();
+          drift.set(surface.target, messages);
+          messages.add(
+            `${surface.target}: pinned ${correction.upstream.join("|")}, found ${tokens.join("|")}`,
+          );
+        } else if (
+          tokens.includes("nil") ||
+          !decodeSlotProse(slot.doc ?? "").includes(correction.reason)
+        ) {
+          verdict = "resolved";
+        } else {
+          verdict = "needed";
+        }
+
+        const seen = verdicts.get(surface.target);
+        if (seen === undefined || RETURN_VERDICT_RANK[verdict] > RETURN_VERDICT_RANK[seen]) {
+          verdicts.set(surface.target, verdict);
+        }
+      }
+    }
+
+    const sightedIn = [...verdicts.keys()].sort();
+    const inBucket = (verdict: ReturnVerdict) =>
+      sightedIn.filter((target) => verdicts.get(target) === verdict);
+    const driftedIn = inBucket("drift");
+    return {
+      key,
+      sightedIn,
+      neededBy: inBucket("needed"),
+      resolvedIn: inBucket("resolved"),
+      driftedIn,
+      typeDrift: driftedIn.flatMap((target) => [...(drift.get(target) ?? [])]).sort(),
+    };
+  });
+}