@fern-api/fdr-sdk 1.2.104-0f39130935 → 1.2.105-a08ab1884d

package/dist/js/api-definition/index.js

@@ -184,24 +184,28 @@ __export(api_definition_exports, {
   buildRequestUrl: () => buildRequestUrl,
   buildSdkSnippetRequest: () => buildSdkSnippetRequest,
   cleanLanguage: () => cleanLanguage,
+  collectGraphqlTypeReferrers: () => collectGraphqlTypeReferrers,
   collectReferencedTypeIds: () => collectReferencedTypeIds,
-  collectReferencingTypeIdsByTypeId: () => collectReferencingTypeIdsByTypeId,
+  collectReferencingTypeIds: () => collectReferencingTypeIds,
   collectTypeDefinitionTree: () => collectTypeDefinitionTree,
   collectTypeDefinitionTreeForObjectProperty: () => collectTypeDefinitionTreeForObjectProperty,
   convertToCurl: () => convertToCurl,
   createEndpointContext: () => createEndpointContext,
   createGraphqlContext: () => createGraphqlContext,
+  createGraphqlTypeContext: () => createGraphqlTypeContext,
   createGrpcContext: () => createGrpcContext,
   createWebSocketContext: () => createWebSocketContext,
   createWebhookContext: () => createWebhookContext,
   filterReferencedTypes: () => filterReferencedTypes,
   generateCurlSnippet: () => generateCurlSnippet,
   generateGraphQlSnippet: () => generateGraphQlSnippet,
+  generateGraphQlTypeSdl: () => generateGraphQlTypeSdl,
   generateHttpSnippets: () => generateHttpSnippets,
   generateSdkSnippetForLanguage: () => generateSdkSnippetForLanguage,
   generateSdkSnippets: () => generateSdkSnippets,
   getGraphqlOperationIds: () => getGraphqlOperationIds,
   getHarRequest: () => getHarRequest,
+  getImplementorTypeIds: () => getImplementorTypeIds,
   getMessageForStatus: () => getMessageForStatus,
   joiner: () => joiner,
   preprocessQueryParameters: () => preprocessQueryParameters,
@@ -212,6 +216,8 @@ __export(api_definition_exports, {
   toColonEndpointPathLiteral: () => toColonEndpointPathLiteral,
   toCurlyBraceEndpointPathLiteral: () => toCurlyBraceEndpointPathLiteral,
   toSnippetHttpRequest: () => toSnippetHttpRequest,
+  trimGraphQlOperationToReferences: () => trimGraphQlOperationToReferences,
+  trimTypeDefinitionToReferences: () => trimTypeDefinitionToReferences,
   unwrapDiscriminatedUnionVariant: () => unwrapDiscriminatedUnionVariant,
   unwrapObjectType: () => unwrapObjectType,
   unwrapReference: () => unwrapReference,
@@ -2575,7 +2581,16 @@ function unwrapObjectType(object5, types, parentVisitedTypeIds) {
       };
     });
   });
-  if (extendedProperties.length === 0) {
+  const propertyKeys = new Set(object5.properties.map((property) => property.key));
+  const seenExtendedKeys = /* @__PURE__ */ new Set();
+  const filteredExtendedProperties = extendedProperties.filter((extendedProperty) => {
+    if (propertyKeys.has(extendedProperty.key) || seenExtendedKeys.has(extendedProperty.key)) {
+      return false;
+    }
+    seenExtendedKeys.add(extendedProperty.key);
+    return true;
+  });
+  if (filteredExtendedProperties.length === 0) {
     const properties2 = (0, import_array.sortBy)(
       [...directProperties],
       [
@@ -2592,15 +2607,6 @@ function unwrapObjectType(object5, types, parentVisitedTypeIds) {
     UnwrapObjectTypeCache.set(object5, toRet2);
     return toRet2;
   }
-  const propertyKeys = new Set(object5.properties.map((property) => property.key));
-  const seenExtendedKeys = /* @__PURE__ */ new Set();
-  const filteredExtendedProperties = extendedProperties.filter((extendedProperty) => {
-    if (propertyKeys.has(extendedProperty.key) || seenExtendedKeys.has(extendedProperty.key)) {
-      return false;
-    }
-    seenExtendedKeys.add(extendedProperty.key);
-    return true;
-  });
   const properties = (0, import_array.sortBy)(
     [...directProperties, ...filteredExtendedProperties],
     [
@@ -3124,6 +3130,115 @@ var ApiTypeIdVisitor = class _ApiTypeIdVisitor {
   }
 };
 
+// src/api-definition/graphql-type-references.ts
+function shapeReferences(shape, typeIds) {
+  let found = false;
+  ApiTypeIdVisitor.visitTypeShape(shape, (typeId) => {
+    if (typeIds.has(typeId)) {
+      found = true;
+    }
+  });
+  return found;
+}
+function definitionReferences(definition, typeIds) {
+  return shapeReferences(definition.shape, typeIds);
+}
+function trimTypeDefinitionToReferences(definition, typeIds) {
+  if (definition.shape.type !== "object") {
+    return definition;
+  }
+  const properties = definition.shape.properties.filter(
+    (property) => shapeReferences(property.valueShape, typeIds) || (property.arguments?.some((argument) => shapeReferences(argument.type, typeIds)) ?? false)
+  );
+  return {
+    ...definition,
+    shape: {
+      ...definition.shape,
+      properties,
+      extraProperties: void 0
+    }
+  };
+}
+function trimGraphQlOperationToReferences(operation, typeIds) {
+  const args = (operation.arguments ?? []).filter((argument) => shapeReferences(argument.type, typeIds));
+  const isReturnType = shapeReferences(operation.returnType, typeIds);
+  if (args.length === 0 && !isReturnType) {
+    return void 0;
+  }
+  return {
+    ...operation,
+    arguments: args.length > 0 ? args : void 0,
+    examples: void 0,
+    snippets: void 0
+  };
+}
+function collectReferencingTypeIds(types, typeIds) {
+  const referencing = [];
+  for (const [rawId, definition] of Object.entries(types)) {
+    const candidateId = rawId;
+    if (typeIds.has(candidateId)) {
+      continue;
+    }
+    if (definitionReferences(definition, typeIds)) {
+      referencing.push(candidateId);
+    }
+  }
+  return referencing;
+}
+function collectGraphqlTypeReferrers(api, typeId) {
+  const target = /* @__PURE__ */ new Set([typeId]);
+  const referrers = [];
+  for (const [rawId, definition] of Object.entries(api.types)) {
+    const candidateId = rawId;
+    if (candidateId === typeId) {
+      continue;
+    }
+    const fields = [];
+    const fieldArguments = [];
+    if (definition.shape.type === "object") {
+      for (const property of definition.shape.properties) {
+        if (shapeReferences(property.valueShape, target)) {
+          fields.push(property.key);
+        }
+        for (const argument of property.arguments ?? []) {
+          if (shapeReferences(argument.type, target)) {
+            fieldArguments.push({ field: property.key, argument: argument.name });
+          }
+        }
+      }
+      if (fields.length === 0 && fieldArguments.length === 0) {
+        continue;
+      }
+    } else if (!definitionReferences(definition, target)) {
+      continue;
+    }
+    referrers.push({
+      type: "type",
+      typeId: candidateId,
+      name: definition.displayName ?? definition.name ?? candidateId,
+      fields,
+      fieldArguments,
+      isVariant: fields.length === 0 && fieldArguments.length === 0
+    });
+  }
+  for (const operation of Object.values(api.graphqlOperations)) {
+    const args = (operation.arguments ?? []).filter((argument) => shapeReferences(argument.type, target)).map((argument) => argument.name);
+    const isReturnType = shapeReferences(operation.returnType, target);
+    if (args.length === 0 && !isReturnType) {
+      continue;
+    }
+    referrers.push({
+      type: "operation",
+      operationId: operation.id,
+      name: operation.displayName ?? operation.name,
+      operationType: operation.operationType,
+      arguments: args,
+      isReturnType
+    });
+  }
+  return referrers;
+}
+
 // src/api-definition/prune.ts
 var ApiDefinitionPruner = class _ApiDefinitionPruner {
   constructor(api) {
@@ -3157,6 +3272,7 @@ var ApiDefinitionPruner = class _ApiDefinitionPruner {
     const namespaces = /* @__PURE__ */ new Set();
     const authSchemes = /* @__PURE__ */ new Set();
     const seedTypeIds = /* @__PURE__ */ new Set();
+    const graphqlTypePageIds = /* @__PURE__ */ new Set();
     for (const node of nodes) {
       if (node.type === "endpoint") {
         const found = this.api.endpoints[node.endpointId];
@@ -3197,10 +3313,17 @@ var ApiDefinitionPruner = class _ApiDefinitionPruner {
         const found = this.api.types[node.typeId];
         if (found) {
           seedTypeIds.add(node.typeId);
+          graphqlTypePageIds.add(node.typeId);
+          for (const implementorId of this.getImplementorTypeIds(node.typeId)) {
+            seedTypeIds.add(implementorId);
+          }
         }
       }
     }
     toRet.types = this.pruneTypes(toRet, seedTypeIds);
+    if (graphqlTypePageIds.size > 0) {
+      this.addBackReferences(toRet, graphqlTypePageIds);
+    }
     namespaces.forEach((subpackageId) => {
       const subpackage = this.api.subpackages[subpackageId];
       if (subpackage) {
@@ -3215,6 +3338,36 @@ var ApiDefinitionPruner = class _ApiDefinitionPruner {
     });
     return toRet;
   }
+  /**
+   * Add what *references* the type a page documents. The closure above walks references
+   * forward, so "what incorporates this type" is absent from a type page's payload unless it
+   * is seeded here; the referring entries are trimmed to the referencing fields and
+   * arguments only, and are deliberately added after `pruneTypes` so their own closures are
+   * not pulled in with them.
+   */
+  addBackReferences(toRet, pageTypeIds) {
+    for (const referencingId of collectReferencingTypeIds(this.api.types, pageTypeIds)) {
+      if (toRet.types[referencingId] != null) {
+        continue;
+      }
+      const definition = this.api.types[referencingId];
+      if (definition != null) {
+        toRet.types[referencingId] = trimTypeDefinitionToReferences(definition, pageTypeIds);
+      }
+    }
+    for (const [operationId, operation] of Object.entries(this.api.graphqlOperations)) {
+      if (toRet.graphqlOperations[operationId] != null) {
+        continue;
+      }
+      const trimmed = trimGraphQlOperationToReferences(operation, pageTypeIds);
+      if (trimmed != null) {
+        toRet.graphqlOperations[operationId] = trimmed;
+      }
+    }
+  }
+  getImplementorTypeIds(typeId) {
+    return getImplementorTypeIds(this.api.types, typeId);
+  }
   pruneTypes(partiallyPrunedApi, seedTypeIds = /* @__PURE__ */ new Set()) {
     let typeIds = new Set(seedTypeIds);
     partiallyPrunedApi.globalHeaders?.forEach((header) => {
@@ -3269,6 +3422,14 @@ var ApiDefinitionPruner = class _ApiDefinitionPruner {
     return visitedTypeIds;
   }
 };
+function getImplementorTypeIds(types, typeId) {
+  return Object.entries(types).filter(
+    ([candidateId, candidate]) => candidateId !== typeId && candidate.shape.type === "object" && candidate.shape.extends.includes(typeId)
+  ).sort(([, a], [, b]) => displayNameOf(a).localeCompare(displayNameOf(b))).map(([candidateId]) => TypeId(candidateId));
+}
+function displayNameOf(type) {
+  return type.displayName ?? type.name;
+}
 function prune(api, ...nodes) {
   return ApiDefinitionPruner.from(api).prune(...nodes);
 }
@@ -3520,6 +3681,34 @@ function createGraphqlContext(node, apiDefinition) {
     types: api.types
   };
 }
+function createGraphqlTypeContext(node, apiDefinition) {
+  if (!node) {
+    console.warn("[createGraphqlTypeContext] node is undefined");
+    return void 0;
+  }
+  if (apiDefinition == null) {
+    console.warn(
+      `[createGraphqlTypeContext] apiDefinition is undefined for node id=${node.id}, typeId=${node.typeId}`
+    );
+    return void 0;
+  }
+  const api = prune(apiDefinition, node);
+  const type = api.types[node.typeId];
+  if (!type) {
+    const availableTypeIds = Object.keys(api.types);
+    console.warn(
+      `[createGraphqlTypeContext] type not found after pruning. typeId=${node.typeId}, apiDefinitionId=${node.apiDefinitionId}, availableTypeIds=[${availableTypeIds.join(", ")}]`
+    );
+    return void 0;
+  }
+  return {
+    node,
+    type,
+    types: api.types,
+    implementors: getImplementorTypeIds(api.types, node.typeId),
+    referencedBy: collectGraphqlTypeReferrers(api, node.typeId)
+  };
+}
 
 // src/api-definition/endpoint-path-literal.ts
 function toColonEndpointPathLiteral(pathParts) {
@@ -5534,6 +5723,50 @@ function generateGraphQlSnippet(context) {
   snippetCache.set(operation, result);
   return result;
 }
+var SDL_KEYWORD = {
+  object: "type",
+  input: "input",
+  interface: "interface",
+  enum: "enum",
+  union: "union",
+  scalar: "scalar"
+};
+function generateGraphQlTypeSdl({
+  name,
+  category,
+  type,
+  types
+}) {
+  const keyword = SDL_KEYWORD[category];
+  const shape = type.shape;
+  if (category === "scalar") {
+    return `scalar ${name}`;
+  }
+  if (category === "union") {
+    const members = shape.type === "undiscriminatedUnion" ? shape.variants.map((variant) => typeShapeToGraphQlType(variant.shape, types, false)) : shape.type === "discriminatedUnion" ? shape.variants.map((variant) => variant.displayName ?? variant.discriminantValue) : [];
+    return members.length > 0 ? `union ${name} = ${members.join(" | ")}` : `union ${name}`;
+  }
+  if (shape.type === "enum") {
+    const values = shape.values.map((value) => `  ${value.value}`);
+    return `enum ${name} {
+${values.join("\n")}
+}`;
+  }
+  if (shape.type === "object") {
+    const implemented = shape.extends.map((typeId) => types[typeId]).filter((implementedType) => implementedType != null).map((implementedType) => implementedType.displayName ?? unnamespacedName(implementedType.name));
+    const heading = implemented.length > 0 ? `${keyword} ${name} implements ${implemented.join(" & ")}` : `${keyword} ${name}`;
+    const fields = shape.properties.map((property) => `  ${objectPropertyToSdlField(property, types)}`);
+    return fields.length > 0 ? `${heading} {
+${fields.join("\n")}
+}` : heading;
+  }
+  return `${keyword} ${name}`;
+}
+function objectPropertyToSdlField(property, types) {
+  const args = property.arguments ?? [];
+  const argList = args.length > 0 ? `(${args.map((arg) => `${arg.name}: ${typeShapeToGraphQlType(arg.type, types)}`).join(", ")})` : "";
+  return `${property.key}${argList}: ${typeShapeToGraphQlType(property.valueShape, types)}`;
+}
 function getOperationKeyword(operationType) {
   switch (operationType) {
     case "QUERY":
@@ -6730,28 +6963,6 @@ var Transformer = class _Transformer {
     };
   };
 };
-
-// src/api-definition/type-back-references.ts
-function collectReferencingTypeIdsByTypeId(api) {
-  const byTypeId = /* @__PURE__ */ new Map();
-  for (const [rawId, definition] of Object.entries(api.types)) {
-    const from = rawId;
-    const seen = /* @__PURE__ */ new Set();
-    ApiTypeIdVisitor.visitTypeDefinition(definition, (to) => {
-      if (to === from || seen.has(to) || api.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;
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ApiAuthSchema,
@@ -6908,24 +7119,28 @@ function collectReferencingTypeIdsByTypeId(api) {
   buildRequestUrl,
   buildSdkSnippetRequest,
   cleanLanguage,
+  collectGraphqlTypeReferrers,
   collectReferencedTypeIds,
-  collectReferencingTypeIdsByTypeId,
+  collectReferencingTypeIds,
   collectTypeDefinitionTree,
   collectTypeDefinitionTreeForObjectProperty,
   convertToCurl,
   createEndpointContext,
   createGraphqlContext,
+  createGraphqlTypeContext,
   createGrpcContext,
   createWebSocketContext,
   createWebhookContext,
   filterReferencedTypes,
   generateCurlSnippet,
   generateGraphQlSnippet,
+  generateGraphQlTypeSdl,
   generateHttpSnippets,
   generateSdkSnippetForLanguage,
   generateSdkSnippets,
   getGraphqlOperationIds,
   getHarRequest,
+  getImplementorTypeIds,
   getMessageForStatus,
   joiner,
   preprocessQueryParameters,
@@ -6936,6 +7151,8 @@ function collectReferencingTypeIdsByTypeId(api) {
   toColonEndpointPathLiteral,
   toCurlyBraceEndpointPathLiteral,
   toSnippetHttpRequest,
+  trimGraphQlOperationToReferences,
+  trimTypeDefinitionToReferences,
   unwrapDiscriminatedUnionVariant,
   unwrapObjectType,
   unwrapReference,