@fern-api/fdr-sdk 1.2.102-1e451b148c → 1.2.103-f004fc2c21

package/dist/js/index.js

@@ -225,6 +225,7 @@ __export(api_definition_exports, {
   buildSdkSnippetRequest: () => buildSdkSnippetRequest,
   cleanLanguage: () => cleanLanguage,
   collectReferencedTypeIds: () => collectReferencedTypeIds,
+  collectReferencingTypeIdsByTypeId: () => collectReferencingTypeIdsByTypeId,
   collectTypeDefinitionTree: () => collectTypeDefinitionTree,
   collectTypeDefinitionTreeForObjectProperty: () => collectTypeDefinitionTreeForObjectProperty,
   convertToCurl: () => convertToCurl,
@@ -3230,6 +3231,7 @@ var ApiDefinitionPruner = class _ApiDefinitionPruner {
     };
     const namespaces = /* @__PURE__ */ new Set();
     const authSchemes = /* @__PURE__ */ new Set();
+    const seedTypeIds = /* @__PURE__ */ new Set();
     for (const node of nodes) {
       if (node.type === "endpoint") {
         const found = this.api.endpoints[node.endpointId];
@@ -3266,9 +3268,14 @@ var ApiDefinitionPruner = class _ApiDefinitionPruner {
             found.namespace?.forEach((subpackageId) => namespaces.add(subpackageId));
           }
         }
+      } else if (node.type === "graphqlType") {
+        const found = this.api.types[node.typeId];
+        if (found) {
+          seedTypeIds.add(node.typeId);
+        }
       }
     }
-    toRet.types = this.pruneTypes(toRet);
+    toRet.types = this.pruneTypes(toRet, seedTypeIds);
     namespaces.forEach((subpackageId) => {
       const subpackage = this.api.subpackages[subpackageId];
       if (subpackage) {
@@ -3283,8 +3290,8 @@ var ApiDefinitionPruner = class _ApiDefinitionPruner {
     });
     return toRet;
   }
-  pruneTypes(partiallyPrunedApi) {
-    let typeIds = /* @__PURE__ */ new Set();
+  pruneTypes(partiallyPrunedApi, seedTypeIds = /* @__PURE__ */ new Set()) {
+    let typeIds = new Set(seedTypeIds);
     partiallyPrunedApi.globalHeaders?.forEach((header) => {
       ApiTypeIdVisitor.visitTypeShape(header.valueShape, (typeId) => typeIds.add(typeId));
     });
@@ -6799,6 +6806,28 @@ var Transformer = class _Transformer {
   };
 };
 
+// src/api-definition/type-back-references.ts
+function collectReferencingTypeIdsByTypeId(api2) {
+  const byTypeId = /* @__PURE__ */ new Map();
+  for (const [rawId, definition] of Object.entries(api2.types)) {
+    const from = rawId;
+    const seen = /* @__PURE__ */ new Set();
+    ApiTypeIdVisitor.visitTypeDefinition(definition, (to) => {
+      if (to === from || seen.has(to) || api2.types[to] == null) {
+        return;
+      }
+      seen.add(to);
+      const existing = byTypeId.get(to);
+      if (existing == null) {
+        byTypeId.set(to, [from]);
+      } else {
+        existing.push(from);
+      }
+    });
+  }
+  return byTypeId;
+}
+
 // src/orpc-client/api/client.ts
 var import_client = require("@orpc/client");
 var import_contract = require("@orpc/contract");
@@ -9612,6 +9641,7 @@ var LedgerArtifactTypeSchema = z21.enum([
   "webhook",
   "grpc",
   "graphql",
+  "graphqlType",
   "changelog",
   "link",
   "file",
@@ -9759,6 +9789,28 @@ var LedgerGraphQlMetadataSchema = LedgerMetadataBaseSchema.extend({
   graphqlOperationId: z21.string(),
   operationType: GraphQlOperationTypeSchema
 });
+var LedgerGraphQlTypeMetadataSchema = LedgerMetadataBaseSchema.extend({
+  ...ApiNodeMetadataFields,
+  typeId: z21.string(),
+  typeCategory: GraphQlTypeCategorySchema,
+  /**
+   * Ids of the types that reference this one directly, for the "referenced by"
+   * section of a type page.
+   *
+   * Computed at publish, because it cannot be derived on the read side: a type
+   * page's pruned definition contains what the type reaches, not what reaches
+   * it, and the navigation tree carries no field-level type references.
+   *
+   * Types rather than operations: where a schema namespaces its operations
+   * behind hub types, almost no operation names a leaf type directly, so an
+   * operation-keyed list is empty for most types. The type graph has the edge
+   * that exists, and it is small -- single digits for the large majority.
+   *
+   * Optional: absent on artifacts written before this field existed, and
+   * omitted entirely when nothing references the type.
+   */
+  referencedByTypeIds: z21.array(z21.string()).optional()
+});
 var LedgerChangelogEntryMetadataSchema = LedgerMetadataBaseSchema.extend({
   ...NodeMetadataFields,
   pageId: z21.string(),
@@ -9803,6 +9855,7 @@ var LedgerArtifactMetadataSchema = z21.union([
   LedgerWebhookMetadataSchema,
   LedgerGrpcMetadataSchema,
   LedgerGraphQlMetadataSchema,
+  LedgerGraphQlTypeMetadataSchema,
   LedgerChangelogEntryMetadataSchema,
   LedgerLinkMetadataSchema,
   LedgerFileArtifactMetadataSchema,
@@ -9816,6 +9869,7 @@ var LEDGER_ARTIFACT_METADATA_SCHEMAS = {
   webhook: LedgerWebhookMetadataSchema,
   grpc: LedgerGrpcMetadataSchema,
   graphql: LedgerGraphQlMetadataSchema,
+  graphqlType: LedgerGraphQlTypeMetadataSchema,
   changelog: LedgerChangelogEntryMetadataSchema,
   link: LedgerLinkMetadataSchema,
   file: LedgerFileArtifactMetadataSchema,
@@ -9848,6 +9902,7 @@ var LedgerNavRouteSchema = z21.discriminatedUnion("type", [
   navRouteVariant("webhook"),
   navRouteVariant("grpc"),
   navRouteVariant("graphql"),
+  navRouteVariant("graphqlType"),
   navRouteVariant("changelog"),
   navRouteVariant("link"),
   navRouteVariant("file"),
@@ -10163,6 +10218,7 @@ var RouteContextResponseSchema = z21.discriminatedUnion("artifactType", [
   artifactTypeVariant(RouteContextResponseBaseSchema, "webhook"),
   artifactTypeVariant(RouteContextResponseBaseSchema, "grpc"),
   artifactTypeVariant(RouteContextResponseBaseSchema, "graphql"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "graphqlType"),
   artifactTypeVariant(RouteContextResponseBaseSchema, "changelog"),
   artifactTypeVariant(RouteContextResponseBaseSchema, "link"),
   artifactTypeVariant(RouteContextResponseBaseSchema, "file"),
@@ -10210,7 +10266,7 @@ var PrunedApiDefinitionInputSchema = z21.object({
   deploymentId: z21.string(),
   apiDefinitionId: z21.string(),
   /** Discriminator matching PruningNodeType.type → artifact metadata field. */
-  nodeType: z21.enum(["endpoint", "webSocket", "webhook", "grpc", "graphql"]),
+  nodeType: z21.enum(["endpoint", "webSocket", "webhook", "grpc", "graphql", "graphqlType"]),
   /** The node ID value (endpointId, webSocketId, etc.). */
   nodeId: z21.string()
 });
@@ -18523,6 +18579,7 @@ function followRedirect(nodeToFollow) {
     webhook: (node) => node.slug,
     grpc: (node) => node.slug,
     graphql: (node) => node.slug,
+    graphqlType: (node) => node.slug,
     landingPage: (node) => node.slug,
     // nodes with overview
     apiPackage: (node) => node.overviewPageId != null ? node.slug : followRedirects(node.children),
@@ -18577,6 +18634,7 @@ function getPageId2(node) {
     webhook: RETURN_UNDEFINED2,
     grpc: RETURN_UNDEFINED2,
     graphql: RETURN_UNDEFINED2,
+    graphqlType: RETURN_UNDEFINED2,
     changelogYear: RETURN_UNDEFINED2,
     changelogMonth: RETURN_UNDEFINED2
   });
@@ -18584,7 +18642,7 @@ function getPageId2(node) {
 
 // src/navigation/versions/v1/NavigationNodeApiLeaf.ts
 function isApiLeaf2(node) {
-  return node.type === "endpoint" || node.type === "webSocket" || node.type === "webhook" || node.type === "grpc" || node.type === "graphql";
+  return node.type === "endpoint" || node.type === "webSocket" || node.type === "webhook" || node.type === "grpc" || node.type === "graphql" || node.type === "graphqlType";
 }
 
 // src/navigation/versions/v1/NavigationNodePageLeaf.ts
@@ -18703,6 +18761,18 @@ function withCanonicalLookup(map) {
   map.has = (key) => originalHas(key) || originalHas(canonicalSlugKey(key));
   return map;
 }
+function graphQlTypeKey(apiDefinitionId, typeId, versionId) {
+  return `${apiDefinitionId}:${versionId ?? ""}:${typeId}`;
+}
+function versionIdOf(parents) {
+  for (let i = parents.length - 1; i >= 0; i--) {
+    const parent = parents[i];
+    if (parent?.type === "version") {
+      return parent.versionId;
+    }
+  }
+  return void 0;
+}
 var NodeCollectorInstances = /* @__PURE__ */ new WeakMap();
 var NodeCollector = class _NodeCollector {
   static EMPTY = new _NodeCollector(void 0);
@@ -18710,6 +18780,8 @@ var NodeCollector = class _NodeCollector {
   idToNode = /* @__PURE__ */ new Map();
   idToNodeParents = /* @__PURE__ */ new Map();
   slugToNode = /* @__PURE__ */ new Map();
+  /** Keyed by {@link graphQlTypeKey} -- `typeId` alone is only unique within one API definition. */
+  typeIdToGraphQlTypeNode = /* @__PURE__ */ new Map();
   orphanedNodes = [];
   static collect(rootNode) {
     if (rootNode == null) {
@@ -18779,6 +18851,13 @@ var NodeCollector = class _NodeCollector {
       this.idToNodeParents.set(node.id, parents);
       this.nodesInOrder.push(node);
     }
+    if (node.type === "graphqlType") {
+      const key = graphQlTypeKey(node.apiDefinitionId, node.typeId, versionIdOf(parents));
+      const existingTypeNode = this.typeIdToGraphQlTypeNode.get(key);
+      if (existingTypeNode == null || existingTypeNode.hidden === true && node.hidden !== true) {
+        this.typeIdToGraphQlTypeNode.set(key, node);
+      }
+    }
     if (node.type === "sidebarRoot") {
       this.#last = void 0;
       this.#lastNeighboringNode = void 0;
@@ -18809,6 +18888,38 @@ var NodeCollector = class _NodeCollector {
   get slugMap() {
     return this.getSlugMap();
   }
+  /**
+   * GraphQL schema types that have their own page, keyed by
+   * {@link graphQlTypeKey} -- `apiDefinitionId` *and* `typeId`.
+   *
+   * Exists so that a field whose value is `Product` can be rendered as a link
+   * to `Product`'s page without every consumer re-walking the tree and picking
+   * its own winner when a type appears under multiple versions or products.
+   *
+   * The key includes the API definition because `typeId` is only unique within
+   * one definition: a docs site with several GraphQL APIs can legitimately have
+   * a `Product` in each, and keying on `typeId` alone would link an operation in
+   * one API to a type page in another.
+   */
+  getGraphQlTypeNodes = (0, import_function.once)(() => {
+    return this.typeIdToGraphQlTypeNode;
+  });
+  /**
+   * The type node documenting `typeId` within `apiDefinitionId` and `versionId`,
+   * if one exists. Pass the version the caller is rendering in; undefined on an
+   * unversioned site.
+   *
+   * There is deliberately no cross-version fallback: sending a reader in one
+   * version to another version's type page is worse than not linking at all,
+   * since the type may differ between versions.
+   */
+  getGraphQlTypeNode = (apiDefinitionId, typeId, versionId) => {
+    return this.typeIdToGraphQlTypeNode.get(graphQlTypeKey(apiDefinitionId, typeId, versionId));
+  };
+  /** Slug of the page documenting `typeId`, if one exists. See {@link getGraphQlTypeNode}. */
+  getGraphQlTypeSlug = (apiDefinitionId, typeId, versionId) => {
+    return this.getGraphQlTypeNode(apiDefinitionId, typeId, versionId)?.slug;
+  };
   get defaultVersionNode() {
     return this.defaultVersion;
   }
@@ -19758,6 +19869,36 @@ var FernNavigationV1ToLatest = class _FernNavigationV1ToLatest {
     };
     return latest;
   };
+  graphqlType = (node, parents) => {
+    const apiDisambiguation = this.#createApiDisambiguationKey(parents);
+    const slug = navigation_exports.Slug(node.slug);
+    const canonicalSlug = this.#getAndSetCanonicalSlug(
+      [
+        `${apiDisambiguation}:api:graphqlType:${node.typeCategory}:${node.typeId}`,
+        this.#createTitleDisambiguationKey(node, parents)
+      ],
+      slug
+    );
+    const latest = {
+      type: "graphqlType",
+      id: navigation_exports.NodeId(node.id),
+      title: node.title,
+      slug,
+      canonicalSlug,
+      icon: node.icon,
+      hidden: node.hidden,
+      authed: node.authed,
+      collapsed: node.collapsed,
+      apiDefinitionId: node.apiDefinitionId,
+      typeId: node.typeId,
+      typeCategory: node.typeCategory,
+      availability: this.#availability(node.availability),
+      viewers: node.viewers,
+      orphaned: node.orphaned,
+      featureFlags: node.featureFlags
+    };
+    return latest;
+  };
   #variantChild = (child, parents) => {
     return visitDiscriminatedUnion_default(child)._visit({
       apiReference: (value) => this.apiReference(value, parents),
@@ -19788,7 +19929,8 @@ var FernNavigationV1ToLatest = class _FernNavigationV1ToLatest {
       webSocket: (value) => this.webSocket(value, parents),
       webhook: (value) => this.webhook(value, parents),
       grpc: (value) => this.grpc(value, parents),
-      graphql: (value) => this.graphql(value, parents)
+      graphql: (value) => this.graphql(value, parents),
+      graphqlType: (value) => this.graphqlType(value, parents)
     });
   };
   /**