fern-api 0.17.1-rc0 → 0.17.2

package/bundle.cjs

@@ -735189,7 +735189,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.17.1-rc0",
+          version: "0.17.2",
           usingAccessToken: true
         }
       });
@@ -735251,7 +735251,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.17.1-rc0",
+        version: "0.17.2",
         ...event,
         ...event.properties
       }
@@ -751420,15 +751420,10 @@ var ExampleTypeFactory = class {
   constructor(schemas) {
     this.schemas = schemas;
   }
-  buildExample({
-    schema: schema2,
-    example,
-    isOptional = false,
-    parameter = false
-  }) {
-    return this.buildExampleHelper({ schema: schema2, isOptional, visitedSchemaIds: /* @__PURE__ */ new Set(), example, parameter });
+  buildExample({ schema: schema2, example, options }) {
+    return this.buildExampleHelper({ schema: schema2, visitedSchemaIds: /* @__PURE__ */ new Set(), example, options, depth: 0 });
   }
-  buildExampleHelper({ example, schema: schema2, isOptional, visitedSchemaIds, parameter = false }) {
+  buildExampleHelper({ example, schema: schema2, depth, visitedSchemaIds, options }) {
     var _a2, _b2;
     switch (schema2.type) {
       case "enum":
@@ -751438,25 +751433,53 @@ var ExampleTypeFactory = class {
         return schema2.values[0] != null ? import_example2.FullExample.enum((_a2 = schema2.values[0]) == null ? void 0 : _a2.value) : void 0;
       case "literal":
         return import_example2.FullExample.literal(schema2.value);
-      case "nullable":
-        return this.buildExampleHelper({
+      case "nullable": {
+        if (example == null && !this.hasExample(schema2.value) && (options.ignoreOptionals || this.exceedsMaxDepth(depth, options))) {
+          return void 0;
+        }
+        const result2 = this.buildExampleHelper({
           schema: schema2.value,
-          isOptional: true,
           visitedSchemaIds,
           example,
-          parameter
+          depth,
+          options
         });
-      case "optional":
-        return this.buildExampleHelper({
+        if (result2 != null && result2.type === "array" && result2.array.length === 0) {
+          return void 0;
+        }
+        if (result2 != null && result2.type === "map" && result2.map.length === 0) {
+          return void 0;
+        }
+        if (result2 != null && result2.type === "object" && Object.keys(result2.properties).length === 0) {
+          return void 0;
+        }
+        return result2;
+      }
+      case "optional": {
+        if (example == null && !this.hasExample(schema2.value) && (options.ignoreOptionals || this.exceedsMaxDepth(depth, options))) {
+          return void 0;
+        }
+        const result2 = this.buildExampleHelper({
           schema: schema2.value,
-          isOptional: true,
           visitedSchemaIds,
           example,
-          parameter
+          depth,
+          options
         });
+        if (result2 != null && result2.type === "array" && result2.array.length === 0) {
+          return void 0;
+        }
+        if (result2 != null && result2.type === "map" && result2.map.length === 0) {
+          return void 0;
+        }
+        if (result2 != null && result2.type === "object" && Object.keys(result2.properties).length === 0) {
+          return void 0;
+        }
+        return result2;
+      }
       case "primitive": {
-        const primitiveExample = this.buildExampleFromPrimitive({ schema: schema2.schema, example, isOptional });
-        return primitiveExample != null ? import_example2.FullExample.primitive(primitiveExample) : void 0;
+        const primitiveExample = this.buildExampleFromPrimitive({ schema: schema2.schema, example, options });
+        return import_example2.FullExample.primitive(primitiveExample);
       }
       case "reference": {
         const referencedSchemaWithExample = this.schemas[schema2.schema];
@@ -751465,9 +751488,9 @@ var ExampleTypeFactory = class {
           const referencedExample = this.buildExampleHelper({
             example,
             schema: referencedSchemaWithExample,
-            isOptional,
             visitedSchemaIds,
-            parameter
+            depth,
+            options
           });
           visitedSchemaIds.delete(schema2.schema);
           return referencedExample;
@@ -751508,9 +751531,9 @@ var ExampleTypeFactory = class {
                 const propertyExample = this.buildExampleHelper({
                   schema: schema3,
                   example: fullExample[property3],
-                  isOptional: !required,
                   visitedSchemaIds,
-                  parameter
+                  depth: depth + 1,
+                  options
                 });
                 if (propertyExample != null) {
                   result2[property3] = propertyExample;
@@ -751521,9 +751544,9 @@ var ExampleTypeFactory = class {
                 const propertyExample = this.buildExampleHelper({
                   schema: schema3,
                   example: fullExample == null ? void 0 : fullExample[property3],
-                  isOptional: !required,
                   visitedSchemaIds,
-                  parameter
+                  depth: depth + 1,
+                  options
                 });
                 if (propertyExample != null) {
                   result2[property3] = propertyExample;
@@ -751542,9 +751565,9 @@ var ExampleTypeFactory = class {
               return this.buildExampleHelper({
                 example,
                 schema: schema2.oneOf.schemas[0],
-                isOptional,
                 visitedSchemaIds,
-                parameter
+                depth,
+                options
               });
             }
             break;
@@ -751558,30 +751581,45 @@ var ExampleTypeFactory = class {
             return import_example2.FullExample.unknown(fullExample);
           }
         }
-        if (isOptional) {
+        if (options.ignoreOptionals || this.exceedsMaxDepth(depth, options)) {
           return void 0;
-        } else if (parameter) {
-          return import_example2.FullExample.primitive(import_example2.PrimitiveExample.string("string"));
         }
-        return import_example2.FullExample.map([]);
+        if (options.isParameter) {
+          return import_example2.FullExample.primitive(import_example2.PrimitiveExample.string(options.name ?? "string"));
+        }
+        return import_example2.FullExample.map([
+          {
+            key: import_example2.PrimitiveExample.string("key"),
+            value: import_example2.FullExample.primitive(import_example2.PrimitiveExample.string("value"))
+          }
+        ]);
       case "array": {
         const fullExample = getFullExampleAsArray(example);
-        if (isOptional && fullExample == null) {
-          return void 0;
-        }
         const itemExamples = [];
-        for (const item of fullExample ?? []) {
-          const itemExample = this.buildExampleHelper({
-            example: item,
-            schema: schema2.value,
-            isOptional: true,
-            visitedSchemaIds,
-            parameter
-          });
-          if (itemExample != null) {
-            itemExamples.push(itemExample);
+        if (fullExample != null && fullExample.length > 0) {
+          for (const item of fullExample) {
+            const itemExample2 = this.buildExampleHelper({
+              example: item,
+              schema: schema2.value,
+              depth: depth + 1,
+              visitedSchemaIds,
+              options
+            });
+            if (itemExample2 != null) {
+              itemExamples.push(itemExample2);
+            }
           }
         }
+        const itemExample = this.buildExampleHelper({
+          example: void 0,
+          schema: schema2.value,
+          depth: depth + 1,
+          visitedSchemaIds,
+          options
+        });
+        if (itemExample != null) {
+          itemExamples.push(itemExample);
+        }
         return import_example2.FullExample.array(itemExamples);
       }
       case "map": {
@@ -751592,16 +751630,16 @@ var ExampleTypeFactory = class {
             const keyExample2 = this.buildExampleFromPrimitive({
               schema: schema2.key.schema,
               example: key2,
-              isOptional
+              options
             });
             const valueExample2 = this.buildExampleHelper({
               example: value,
               schema: schema2.value,
-              isOptional,
               visitedSchemaIds,
-              parameter
+              depth: depth + 1,
+              options
             });
-            if (keyExample2 != null && valueExample2 != null) {
+            if (valueExample2 != null) {
               kvs.push({
                 key: keyExample2,
                 value: valueExample2
@@ -751613,16 +751651,16 @@ var ExampleTypeFactory = class {
         const keyExample = this.buildExampleFromPrimitive({
           schema: schema2.key.schema,
           example: void 0,
-          isOptional
+          options
         });
         const valueExample = this.buildExampleHelper({
           example: void 0,
           schema: schema2.value,
-          isOptional,
           visitedSchemaIds,
-          parameter
+          depth: depth + 1,
+          options
         });
-        if (keyExample != null && valueExample != null) {
+        if (valueExample != null) {
           return import_example2.FullExample.map([
             {
               key: keyExample,
@@ -751630,7 +751668,7 @@ var ExampleTypeFactory = class {
             }
           ]);
         }
-        return isOptional ? void 0 : import_example2.FullExample.map([]);
+        return import_example2.FullExample.map([]);
       }
       case "object": {
         const result2 = {};
@@ -751642,25 +751680,82 @@ var ExampleTypeFactory = class {
           const propertyExample = this.buildExampleHelper({
             schema: schema3,
             example: fullExample[property3],
-            isOptional: !required,
             visitedSchemaIds,
-            parameter
+            depth: depth + 1,
+            options: {
+              ...options,
+              name: property3
+            }
           });
           if (propertyExample != null) {
             result2[property3] = propertyExample;
           } else if (required) {
-            return void 0;
+            const generatedExample = this.buildExampleHelper({
+              schema: schema3,
+              example: fullExample[property3],
+              visitedSchemaIds,
+              depth: depth + 1,
+              options: {
+                ...options,
+                name: property3
+              }
+            });
+            if (generatedExample == null) {
+              return void 0;
+            }
+            result2[property3] = generatedExample;
           }
         }
-        const a2 = import_example2.FullExample.object({
+        return import_example2.FullExample.object({
           properties: result2
         });
-        return a2;
       }
       default:
         assertNever(schema2);
     }
   }
+  hasExample(schema2) {
+    switch (schema2.type) {
+      case "array":
+        return this.hasExample(schema2.value);
+      case "enum":
+        return schema2.example != null;
+      case "literal":
+        return false;
+      case "map":
+        return schema2.key.schema.example != null && this.hasExample(schema2.value);
+      case "object": {
+        const objectExample = schema2.fullExamples != null && schema2.fullExamples.length > 0;
+        if (objectExample) {
+          return true;
+        }
+        for (const property3 of schema2.properties) {
+          if (this.hasExample(property3.schema)) {
+            return true;
+          }
+        }
+        return false;
+      }
+      case "primitive":
+        return schema2.schema.example != null;
+      case "reference": {
+        const resolvedSchema = this.schemas[schema2.schema];
+        if (resolvedSchema != null) {
+          return this.hasExample(resolvedSchema);
+        }
+        return false;
+      }
+      case "unknown":
+        return schema2.example != null;
+      case "oneOf":
+        return Object.values(schema2.oneOf.schemas).some((schema3) => this.hasExample(schema3));
+      default:
+        return false;
+    }
+  }
+  exceedsMaxDepth(depth, options) {
+    return depth > (options.maxDepth ?? 0);
+  }
   getAllProperties(object2) {
     let properties = {};
     for (const property3 of object2.properties) {
@@ -751716,89 +751811,80 @@ var ExampleTypeFactory = class {
     }
     return schema2;
   }
-  buildExampleFromPrimitive({ isOptional, example, schema: schema2 }) {
+  buildExampleFromPrimitive({ example, schema: schema2, options }) {
     switch (schema2.type) {
       case "string":
         if (example != null && typeof example === "string") {
           return import_example2.PrimitiveExample.string(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.string(schema2.example);
-        } else if (!isOptional) {
-          return import_example2.PrimitiveExample.string("string");
+        } else {
+          return import_example2.PrimitiveExample.string(options.name ?? "string");
         }
-        return void 0;
       case "base64":
         if (example != null && typeof example === "string") {
           return import_example2.PrimitiveExample.base64(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.base64(schema2.example);
-        } else if (!isOptional) {
+        } else {
           return import_example2.PrimitiveExample.base64("SGVsbG8gd29ybGQh");
         }
-        return void 0;
       case "boolean":
         if (example != null && typeof example === "boolean") {
           return import_example2.PrimitiveExample.boolean(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.boolean(schema2.example);
-        } else if (!isOptional) {
+        } else {
           return import_example2.PrimitiveExample.boolean(true);
         }
-        return void 0;
       case "date":
         if (example != null && typeof example === "string") {
           return import_example2.PrimitiveExample.date(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.date(schema2.example);
-        } else if (!isOptional) {
+        } else {
           return import_example2.PrimitiveExample.date("2023-01-15");
         }
-        return void 0;
       case "datetime":
         if (example != null && typeof example === "string") {
           return import_example2.PrimitiveExample.datetime(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.datetime(schema2.example);
-        } else if (!isOptional) {
+        } else {
           return import_example2.PrimitiveExample.datetime("2024-01-15T09:30:00Z");
         }
-        return void 0;
       case "double":
         if (example != null && typeof example === "number") {
           return import_example2.PrimitiveExample.double(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.double(schema2.example);
-        } else if (!isOptional) {
+        } else {
           return import_example2.PrimitiveExample.double(1.1);
         }
-        return void 0;
       case "float":
         if (example != null && typeof example === "number") {
           return import_example2.PrimitiveExample.float(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.float(schema2.example);
-        } else if (!isOptional) {
+        } else {
           return import_example2.PrimitiveExample.float(1.1);
         }
-        return void 0;
       case "int":
         if (example != null && typeof example === "number") {
           return import_example2.PrimitiveExample.int(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.int(1);
-        } else if (!isOptional) {
+        } else {
           return import_example2.PrimitiveExample.int(1);
         }
-        return void 0;
       case "int64":
         if (example != null && typeof example === "number") {
           return import_example2.PrimitiveExample.int64(example);
         } else if (schema2.example != null) {
           return import_example2.PrimitiveExample.int64(schema2.example);
-        } else if (!isOptional) {
+        } else {
           return import_example2.PrimitiveExample.int64(1e6);
         }
-        return void 0;
       default:
         assertNever(schema2);
     }
@@ -751834,8 +751920,10 @@ var ExampleEndpointFactory = class {
       requestExample = this.exampleTypeFactory.buildExample({
         schema: requestSchemaIdResponse.schema,
         example: (_a2 = requestSchemaIdResponse.example) == null ? void 0 : _a2.value,
-        isOptional: !required,
-        parameter: false
+        options: {
+          isParameter: false,
+          ignoreOptionals: true
+        }
       });
       if (required && requestExample == null) {
         return void 0;
@@ -751847,8 +751935,11 @@ var ExampleEndpointFactory = class {
       responseExample = this.exampleTypeFactory.buildExample({
         schema: responseSchemaIdResponse.schema,
         example: (_b2 = responseSchemaIdResponse.example) == null ? void 0 : _b2.value,
-        isOptional: !required,
-        parameter: false
+        options: {
+          isParameter: false,
+          ignoreOptionals: false,
+          maxDepth: 3
+        }
       });
       if (required && responseExample == null) {
         return void 0;
@@ -751859,9 +751950,12 @@ var ExampleEndpointFactory = class {
       const required = this.isSchemaRequired(pathParameter.schema);
       let example = this.exampleTypeFactory.buildExample({
         schema: pathParameter.schema,
-        isOptional: !required,
         example: void 0,
-        parameter: true
+        options: {
+          name: pathParameter.name,
+          isParameter: true,
+          ignoreOptionals: true
+        }
       });
       if (example != null && !isExamplePrimitive(example)) {
         example = void 0;
@@ -751880,9 +751974,12 @@ var ExampleEndpointFactory = class {
       const required = this.isSchemaRequired(queryParameter.schema);
       let example = this.exampleTypeFactory.buildExample({
         schema: queryParameter.schema,
-        isOptional: !required,
         example: void 0,
-        parameter: true
+        options: {
+          name: queryParameter.name,
+          isParameter: true,
+          ignoreOptionals: true
+        }
       });
       if (example != null && !isExamplePrimitive(example)) {
         example = void 0;
@@ -751901,9 +751998,12 @@ var ExampleEndpointFactory = class {
       const required = this.isSchemaRequired(header.schema);
       let example = this.exampleTypeFactory.buildExample({
         schema: header.schema,
-        isOptional: !required,
         example: void 0,
-        parameter: true
+        options: {
+          name: header.name,
+          isParameter: true,
+          ignoreOptionals: true
+        }
       });
       if (example != null && !isExamplePrimitive(example)) {
         example = void 0;
@@ -760945,10 +761045,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.17.1-rc0" == null) {
+    if ("0.17.2" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.17.1-rc0";
+    return "0.17.2";
   }
   getCliName() {
     if ("fern" == null) {
@@ -777187,13 +777287,20 @@ function getColorType({ background, accentPrimary }) {
 function convertThemedColorConfig(rawConfig, context, theme) {
   let accentPrimaryColor = getColorInstanceFromRawConfig(rawConfig.accentPrimary, context, "accentPrimary", theme);
   let backgroundColor = getColorInstanceFromRawConfig(rawConfig.background, context, "background", theme);
-  backgroundColor = enforceTheme(backgroundColor, context, "background", theme);
-  accentPrimaryColor = enforceTheme(accentPrimaryColor, context, "accentPrimary", theme === "dark" ? "light" : "dark");
-  if (accentPrimaryColor != null && backgroundColor != null) {
-    if (!tinycolor.isReadable(accentPrimaryColor, backgroundColor)) {
-      const ratio = tinycolor.readability(accentPrimaryColor, backgroundColor);
-      accentPrimaryColor = tinycolor.mostReadable(backgroundColor, accentPrimaryColor.monochromatic(3));
-      context.logger.warn(`The accent color is not readable on the background color in ${theme} mode. The contrast ratio is ${ratio}. We've adjusted the accent color to ${accentPrimaryColor.toHexString()} to improve readability.`);
+  if (backgroundColor != null) {
+    const newBackgroundColor = enforceBackgroundTheme(tinycolor(backgroundColor.toString()), theme);
+    if (newBackgroundColor.toHexString() !== backgroundColor.toHexString()) {
+      context.logger.warn(`The chosen shade, 'backgroundColor' in ${theme} mode, fails to meet minimum contrast requirements. The brightness is ${backgroundColor.getBrightness()}. To enhance accessibility and ensure content readability, Fern will adjust from ${backgroundColor.toHexString()} to a more contrast-rich ${newBackgroundColor.toHexString()}.`);
+      backgroundColor = newBackgroundColor;
+    }
+  }
+  if (accentPrimaryColor != null) {
+    const backgroundColorWithFallback = backgroundColor ?? tinycolor(theme === "dark" ? "#000" : "#FFF");
+    const newAccentPrimaryColor = increaseForegroundContrast(tinycolor(accentPrimaryColor.toString()), backgroundColorWithFallback);
+    if (newAccentPrimaryColor.toHexString() !== accentPrimaryColor.toHexString()) {
+      const ratio = tinycolor.readability(accentPrimaryColor, backgroundColorWithFallback);
+      context.logger.warn(`The chosen shade, 'accentColor' in ${theme} mode, fails to meet minimum contrast requirements. The contrast ratio is ${ratio}, which is below WCAG AA requirements (4.5:1). To enhance accessibility and ensure content readability, Fern will adjust from ${accentPrimaryColor.toHexString()} to a more contrast-rich ${newAccentPrimaryColor.toHexString()}.`);
+      accentPrimaryColor = newAccentPrimaryColor;
     }
   }
   return {
@@ -777201,25 +777308,31 @@ function convertThemedColorConfig(rawConfig, context, theme) {
     background: toRgb2(backgroundColor)
   };
 }
-function enforceTheme(color3, context, key2, theme) {
-  if (color3 == null) {
-    return void 0;
+function increaseForegroundContrast(foregroundColor, backgroundColor) {
+  let newForgroundColor = foregroundColor;
+  const dark = backgroundColor.isDark();
+  while (!tinycolor.isReadable(newForgroundColor, backgroundColor)) {
+    if (dark ? newForgroundColor.getBrightness() === 255 : newForgroundColor.getBrightness() === 0) {
+      break;
+    }
+    newForgroundColor = dark ? newForgroundColor.lighten(1) : newForgroundColor.darken(1);
   }
+  return newForgroundColor;
+}
+function enforceBackgroundTheme(color3, theme) {
   if (theme === "dark" && color3.isDark()) {
     return color3;
   } else if (theme === "light" && color3.isLight()) {
     return color3;
   }
-  const newColor = getOppositeLuminance(color3);
-  context.logger.warn(`The ${key2} color should be ${theme}. We've adjusted the color to ${newColor.toHexString()} to match the theme by flipping its luminance.`);
-  return newColor;
+  return getOppositeBrightness(color3);
 }
-function getOppositeLuminance(color3) {
+function getOppositeBrightness(color3) {
   if (color3 == null) {
     return void 0;
   }
-  const { h: h3, s: s2, l: l2 } = color3.toHsl();
-  return tinycolor({ h: h3, s: s2, l: 1 - l2 });
+  const { h: h3, s: s2, v: v2 } = color3.toHsv();
+  return tinycolor({ h: h3, s: s2, v: 1 - v2 });
 }
 function toRgb2(color3) {
   if (color3 == null) {

package/package.json

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