fern-api 0.23.6 → 0.24.0

package/bundle.cjs

@@ -344910,6 +344910,7 @@ var init_OpenApiIntermediateRepresentation2 = __esm({
     OpenApiIntermediateRepresentation = schemas_exports5.objectWithoutOptionalProperties({
       title: schemas_exports5.string().optional(),
       description: schemas_exports5.string().optional(),
+      basePath: schemas_exports5.string().optional(),
       servers: schemas_exports5.list(schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).Server)),
       groups: schemas_exports5.record(schemas_exports5.string(), schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).SdkGroupInfo)),
       tags: schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).Tags),
@@ -345019,7 +345020,8 @@ var init_WebsocketHandshake2 = __esm({
     init_core3();
     WebsocketHandshake = schemas_exports5.objectWithoutOptionalProperties({
       queryParameters: schemas_exports5.list(schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).QueryParameter)),
-      headers: schemas_exports5.list(schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).Header))
+      headers: schemas_exports5.list(schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).Header)),
+      pathParameters: schemas_exports5.list(schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).PathParameter))
     });
   }
 });
@@ -345716,6 +345718,7 @@ var init_ObjectProperty4 = __esm({
       schema: schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).Schema),
       conflict: schemas_exports5.record(schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).SchemaId), schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).ObjectPropertyConflictInfo)),
       generatedName: schemas_exports5.string(),
+      nameOverride: schemas_exports5.string().optional(),
       audiences: schemas_exports5.list(schemas_exports5.string())
     });
   }
@@ -346373,6 +346376,7 @@ var init_ObjectPropertyWithExample2 = __esm({
       schema: schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).SchemaWithExample),
       audiences: schemas_exports5.list(schemas_exports5.string()),
       conflict: schemas_exports5.record(schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).SchemaId), schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).ObjectPropertyConflictInfo)),
+      nameOverride: schemas_exports5.string().optional(),
       generatedName: schemas_exports5.string()
     });
   }
@@ -890696,7 +890700,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.23.6",
+          version: "0.24.0",
           usingAccessToken: true
         }
       });
@@ -890758,7 +890762,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.23.6",
+        version: "0.24.0",
         ...event,
         ...event.properties
       }
@@ -903034,8 +903038,14 @@ function buildObjectTypeDeclaration({ schema: schema2, context, declarationFile
       context,
       fileContainingReference: declarationFile
     });
-    if (property5.audiences.length > 0) {
-      properties[property5.key] = typeof typeReference === "string" ? { type: typeReference, audiences: property5.audiences } : { ...typeReference, audiences: property5.audiences };
+    const audiences = property5.audiences;
+    const name2 = property5.nameOverride;
+    if (audiences.length > 0 && name2 != null) {
+      properties[property5.key] = typeof typeReference === "string" ? { type: typeReference, audiences, name: name2 } : { ...typeReference, audiences, name: name2 };
+    } else if (name2 != null) {
+      properties[property5.key] = typeof typeReference === "string" ? { type: typeReference, name: name2 } : { ...typeReference, name: name2 };
+    } else if (audiences.length > 0) {
+      properties[property5.key] = typeof typeReference === "string" ? { type: typeReference, audiences } : { ...typeReference, audiences };
     } else {
       properties[property5.key] = typeReference;
     }
@@ -903493,6 +903503,27 @@ function buildHeader({ header, context, fileContainingReference }) {
   return headerSchema;
 }
 
+// pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/buildPathParameter.js
+function buildPathParameter({ pathParameter, context, fileContainingReference }) {
+  const typeReference = buildTypeReference({
+    schema: pathParameter.schema,
+    context,
+    fileContainingReference
+  });
+  if (pathParameter.variableReference == null && pathParameter.description == null) {
+    return getTypeFromTypeReference(typeReference);
+  }
+  const pathParameterSchema = pathParameter.variableReference != null ? {
+    variable: `$${pathParameter.variableReference}`
+  } : {
+    type: getTypeFromTypeReference(typeReference)
+  };
+  if (pathParameter.description != null) {
+    pathParameterSchema.docs = pathParameter.description;
+  }
+  return pathParameterSchema;
+}
+
 // pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/parse.js
 var import_promises25 = require("fs/promises");
 
@@ -903548,6 +903579,7 @@ var FernOpenAPIExtension = {
   BOOLEAN_LITERAL: "x-fern-boolean-literal",
   SERVER_NAME_V1: "x-name",
   SERVER_NAME_V2: "x-fern-server-name",
+  BASE_PATH: "x-fern-base-path",
   GROUPS: TypedExtensionId.of("x-fern-groups"),
   OPENAPI_OVERIDES_FILEPATH: "x-fern-overrides-filepath",
   TYPE_DEFINITION: "x-fern-type",
@@ -903572,7 +903604,8 @@ var FernOpenAPIExtension = {
   FERN_BEARER_TOKEN: "x-fern-bearer",
   FERN_HEADER_AUTH: "x-fern-header",
   FERN_BASIC_AUTH: "x-fern-basic",
-  FERN_GLOBAL_HEADERS: "x-fern-global-headers"
+  FERN_GLOBAL_HEADERS: "x-fern-global-headers",
+  FERN_PROPERTY_NAME: "x-fern-property-name"
 };
 
 // pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/v3/extensions/getFernEnum.js
@@ -904524,7 +904557,8 @@ function convertToObjectProperty(objectProperty) {
     generatedName: objectProperty.generatedName,
     key: objectProperty.key,
     schema: convertSchemaWithExampleToSchema(objectProperty.schema),
-    audiences: objectProperty.audiences
+    audiences: objectProperty.audiences,
+    nameOverride: objectProperty.nameOverride
   };
 }
 
@@ -904684,6 +904718,7 @@ function convertObject({ nameOverride, generatedName, breadcrumbs, properties, d
   const convertedProperties = Object.entries(propertiesToConvert).map(([propertyName, propertySchema]) => {
     const isRequired = allRequired.includes(propertyName);
     const audiences = getExtension(propertySchema, FernOpenAPIExtension.AUDIENCES) ?? [];
+    const propertyNameOverride = getExtension(propertySchema, FernOpenAPIExtension.FERN_PROPERTY_NAME);
     const propertyBreadcrumbs = [...breadcrumbs, propertyName];
     const generatedName2 = getGeneratedPropertyName(propertyBreadcrumbs);
     const schema2 = isRequired ? convertSchema(propertySchema, false, context, propertyBreadcrumbs) : SchemaWithExample.optional({
@@ -904705,6 +904740,7 @@ function convertObject({ nameOverride, generatedName, breadcrumbs, properties, d
     return {
       key: propertyName,
       schema: schema2,
+      nameOverride: propertyNameOverride,
       audiences,
       conflict: conflicts,
       generatedName: getGeneratedPropertyName([...breadcrumbs, propertyName])
@@ -906519,7 +906555,8 @@ function convertToObjectProperty2(objectProperty) {
     generatedName: objectProperty.generatedName,
     key: objectProperty.key,
     schema: convertSchemaToSchemaWithExample(objectProperty.schema),
-    audiences: objectProperty.audiences
+    audiences: objectProperty.audiences,
+    nameOverride: objectProperty.nameOverride
   };
 }
 
@@ -906937,7 +906974,8 @@ function convertMultipartRequestToSchema(request) {
         schema: convertSchemaToSchemaWithExample(property5.schema.value),
         audiences: [],
         conflict: {},
-        generatedName: property5.key
+        generatedName: property5.key,
+        nameOverride: void 0
       };
     }).filter(isNonNullish),
     allOf: [],
@@ -907189,6 +907227,28 @@ function parseAsyncAPI({ document: document6, taskContext }) {
       context.logger.error(`Channel ${channelPath} does not have websocket bindings. Skipping.`);
       continue;
     }
+    const pathParameters = [];
+    if (channel.parameters != null) {
+      for (const [name2, parameter] of Object.entries(channel.parameters ?? {})) {
+        pathParameters.push({
+          name: name2,
+          description: parameter.description,
+          schema: parameter.schema != null ? convertSchema(parameter.schema, false, context, breadcrumbs) : SchemaWithExample.primitive({
+            schema: PrimitiveSchemaValueWithExample.string({
+              example: void 0,
+              format: void 0,
+              maxLength: void 0,
+              minLength: void 0
+            }),
+            description: void 0,
+            generatedName: "",
+            groupName: void 0,
+            nameOverride: void 0
+          }),
+          variableReference: void 0
+        });
+      }
+    }
     const headers = [];
     if (channel.bindings.ws.headers != null) {
       const required = channel.bindings.ws.headers.required ?? [];
@@ -907276,6 +907336,12 @@ function parseAsyncAPI({ document: document6, taskContext }) {
               ...param,
               schema: convertSchemaWithExampleToSchema(param.schema)
             };
+          }),
+          pathParameters: pathParameters.map((param) => {
+            return {
+              ...param,
+              schema: convertSchemaWithExampleToSchema(param.schema)
+            };
           })
         },
         groupName: (tag == null ? void 0 : tag.name) != null ? [tag.name] : ["Websocket"],
@@ -908794,6 +908860,11 @@ function getScopes(oauthSecurityScheme) {
   return void 0;
 }
 
+// pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/v3/extensions/getFernBasePath.js
+function getFernBasePath(parameter) {
+  return getExtension(parameter, FernOpenAPIExtension.BASE_PATH);
+}
+
 // pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/v3/extensions/getFernGroups.js
 var XFernGroupsSchema = z.record(z.string(), z.object({
   summary: z.string().optional(),
@@ -909142,6 +909213,7 @@ function generateIr({ openApi, taskContext, disableExamples, audiences }) {
   });
   const groupInfo = getFernGroups({ document: openApi, context });
   const ir = {
+    basePath: getFernBasePath(openApi),
     title: openApi.info.title,
     description: openApi.info.description,
     groups: Object.fromEntries(Object.entries(groupInfo ?? {}).map(([key2, value]) => {
@@ -909260,6 +909332,7 @@ async function parse3({ workspace, taskContext }) {
   let ir = {
     title: void 0,
     description: void 0,
+    basePath: void 0,
     servers: [],
     tags: {
       tagsById: {},
@@ -909327,6 +909400,7 @@ function merge3(ir1, ir2) {
   return {
     title: ir1.title ?? ir2.title,
     description: ir1.description ?? ir2.description,
+    basePath: ir1.basePath ?? ir2.basePath,
     servers: [...ir1.servers, ...ir2.servers],
     tags: {
       tagsById: {
@@ -909728,6 +909802,19 @@ function buildChannel({ channel, context, declarationFile }) {
   if (channel.summary != null) {
     convertedChannel["display-name"] = channel.summary;
   }
+  const pathParameters = {};
+  if (channel.handshake.pathParameters.length > 0) {
+    for (const pathParameter of channel.handshake.pathParameters) {
+      pathParameters[pathParameter.name] = buildPathParameter({
+        pathParameter,
+        context,
+        fileContainingReference: declarationFile
+      });
+    }
+  }
+  if (Object.keys(pathParameters).length > 0) {
+    convertedChannel["path-parameters"] = pathParameters;
+  }
   const queryParameters = {};
   if (channel.handshake.queryParameters.length > 0) {
     for (const queryParameter of channel.handshake.queryParameters) {
@@ -910118,27 +910205,6 @@ function convertLiteralExample2(literal2) {
   }
 }
 
-// pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/buildPathParameter.js
-function buildPathParameter({ pathParameter, context, fileContainingReference }) {
-  const typeReference = buildTypeReference({
-    schema: pathParameter.schema,
-    context,
-    fileContainingReference
-  });
-  if (pathParameter.variableReference == null && pathParameter.description == null) {
-    return getTypeFromTypeReference(typeReference);
-  }
-  const pathParameterSchema = pathParameter.variableReference != null ? {
-    variable: `$${pathParameter.variableReference}`
-  } : {
-    type: getTypeFromTypeReference(typeReference)
-  };
-  if (pathParameter.description != null) {
-    pathParameterSchema.docs = pathParameter.description;
-  }
-  return pathParameterSchema;
-}
-
 // pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/utils/convertToHttpMethod.js
 function convertToHttpMethod(httpMethod) {
   return HttpMethod5._visit(httpMethod, {
@@ -910811,6 +910877,9 @@ function buildFernDefinition(context) {
   buildGlobalHeaders(context);
   buildAuthSchemes(context);
   buildVariables(context);
+  if (context.ir.basePath != null) {
+    context.builder.setBasePath(context.ir.basePath);
+  }
   if (context.ir.hasEndpointsMarkedInternal) {
     context.builder.addAudience(EXTERNAL_AUDIENCE);
   }
@@ -910908,6 +910977,9 @@ var FernDefinitionBuilderImpl = class {
   setDefaultEnvironment(name2) {
     this.rootApiFile["default-environment"] = name2;
   }
+  setBasePath(basePath) {
+    this.rootApiFile["base-path"] = basePath;
+  }
   getEnvironmentType() {
     const environmentEntry = Object.entries(this.rootApiFile.environments ?? {})[0];
     if (environmentEntry == null) {
@@ -911541,9 +911613,31 @@ async function loadAPIWorkspace({ absolutePathToWorkspace, context, cliVersion,
   if ((generatorsConfiguration == null ? void 0 : generatorsConfiguration.api) != null && generatorsConfiguration.api.definitions.length > 0) {
     const specs = [];
     for (const definition3 of generatorsConfiguration.api.definitions) {
+      const absoluteFilepath = join(absolutePathToWorkspace, RelativeFilePath.of(definition3.path));
+      const absoluteFilepathToOverrides = definition3.overrides != null ? join(absolutePathToWorkspace, RelativeFilePath.of(definition3.overrides)) : void 0;
+      if (!await doesPathExist(absoluteFilepath)) {
+        return {
+          didSucceed: false,
+          failures: {
+            [RelativeFilePath.of(definition3.path)]: {
+              type: WorkspaceLoaderFailureType.FILE_MISSING
+            }
+          }
+        };
+      }
+      if (definition3.overrides != null && absoluteFilepathToOverrides != null && !await doesPathExist(absoluteFilepathToOverrides)) {
+        return {
+          didSucceed: false,
+          failures: {
+            [RelativeFilePath.of(definition3.overrides)]: {
+              type: WorkspaceLoaderFailureType.FILE_MISSING
+            }
+          }
+        };
+      }
       specs.push({
-        absoluteFilepath: join(absolutePathToWorkspace, RelativeFilePath.of(definition3.path)),
-        absoluteFilepathToOverrides: definition3.overrides != null ? join(absolutePathToWorkspace, RelativeFilePath.of(definition3.overrides)) : void 0,
+        absoluteFilepath,
+        absoluteFilepathToOverrides,
         settings: {
           audiences: definition3.audiences ?? []
         }
@@ -911578,6 +911672,16 @@ async function loadAPIWorkspace({ absolutePathToWorkspace, context, cliVersion,
         absoluteFilepathToOverrides: void 0
       });
     }
+    if (absolutePathToOpenAPI != null && absolutePathToAsyncAPI != null) {
+      return {
+        didSucceed: false,
+        failures: {
+          [RelativeFilePath.of("openapi/openapi.yml")]: {
+            type: WorkspaceLoaderFailureType.FILE_MISSING
+          }
+        }
+      };
+    }
     return {
       didSucceed: true,
       workspace: {
@@ -915217,10 +915321,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.23.6" == null) {
+    if ("0.24.0" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.23.6";
+    return "0.24.0";
   }
   getCliName() {
     if ("fern" == null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fern-api",
-  "version": "0.23.6",
+  "version": "0.24.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern.git",