@fern-api/fern-api-dev 5.118.0 → 5.119.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli.cjs +72 -10
- package/package.json +1 -1
package/cli.cjs
CHANGED
|
@@ -118484,6 +118484,7 @@ var init_DocsYmlSchemas = __esm({
|
|
|
118484
118484
|
"mobile-toc": external_exports.boolean().optional(),
|
|
118485
118485
|
"changelog-layout": ChangelogLayout.optional(),
|
|
118486
118486
|
"api-reference-layout": ApiReferenceLayout.optional(),
|
|
118487
|
+
"api-reference-expand-properties": external_exports.boolean().optional(),
|
|
118487
118488
|
"show-nav-availability-badges": external_exports.boolean().optional()
|
|
118488
118489
|
});
|
|
118489
118490
|
SearchSettingsConfig = external_exports.object({
|
|
@@ -124182,6 +124183,7 @@ var init_LayoutConfig2 = __esm({
|
|
|
124182
124183
|
mobileToc: schemas_exports6.property("mobile-toc", schemas_exports6.boolean().optional()),
|
|
124183
124184
|
changelogLayout: schemas_exports6.property("changelog-layout", ChangelogLayout3.optional()),
|
|
124184
124185
|
apiReferenceLayout: schemas_exports6.property("api-reference-layout", ApiReferenceLayout3.optional()),
|
|
124186
|
+
apiReferenceExpandProperties: schemas_exports6.property("api-reference-expand-properties", schemas_exports6.boolean().optional()),
|
|
124185
124187
|
showNavAvailabilityBadges: schemas_exports6.property("show-nav-availability-badges", schemas_exports6.boolean().optional())
|
|
124186
124188
|
});
|
|
124187
124189
|
}
|
|
@@ -238684,6 +238686,10 @@ function convertLayoutConfig(layout, themeTabsAlignment, themeTabsPlacement) {
|
|
|
238684
238686
|
// by the fern-platform companion PR. Part of the `as unknown as` cast
|
|
238685
238687
|
// below until the published FDR SDK adds `apiReferenceLayout`.
|
|
238686
238688
|
apiReferenceLayout: layout.apiReferenceLayout,
|
|
238689
|
+
// Opt-in (default off, resolved by the fern-platform companion PR): when
|
|
238690
|
+
// true the first level of nested API reference fields renders expanded.
|
|
238691
|
+
// Part of the `as unknown as` cast below until the published FDR SDK adds the field.
|
|
238692
|
+
apiReferenceExpandProperties: layout.apiReferenceExpandProperties,
|
|
238687
238693
|
// Opt-in (default off, resolved by the fern-platform companion PR):
|
|
238688
238694
|
// when true the sidebar renders inline availability badges. Part of the
|
|
238689
238695
|
// `as unknown as` cast below until the published FDR SDK adds the field.
|
|
@@ -353911,7 +353917,8 @@ var init_AbstractParameterConverter = __esm({
|
|
|
353911
353917
|
clientDefault: void 0,
|
|
353912
353918
|
defaultValue: parameterDefaultValue,
|
|
353913
353919
|
v2Examples: this.convertParameterExamples({
|
|
353914
|
-
schema: parameterSchemaWithExampleOverride ?? schema
|
|
353920
|
+
schema: parameterSchemaWithExampleOverride ?? schema,
|
|
353921
|
+
originalSchema: schema
|
|
353915
353922
|
}),
|
|
353916
353923
|
availability,
|
|
353917
353924
|
explode: this.getExplodeForQueryParameter()
|
|
@@ -353932,7 +353939,8 @@ var init_AbstractParameterConverter = __esm({
|
|
|
353932
353939
|
clientDefault: void 0,
|
|
353933
353940
|
defaultValue: parameterDefaultValue,
|
|
353934
353941
|
v2Examples: this.convertParameterExamples({
|
|
353935
|
-
schema: parameterSchemaWithExampleOverride ?? schema
|
|
353942
|
+
schema: parameterSchemaWithExampleOverride ?? schema,
|
|
353943
|
+
originalSchema: schema
|
|
353936
353944
|
}),
|
|
353937
353945
|
availability
|
|
353938
353946
|
},
|
|
@@ -353949,7 +353957,8 @@ var init_AbstractParameterConverter = __esm({
|
|
|
353949
353957
|
variable: void 0,
|
|
353950
353958
|
clientDefault: void 0,
|
|
353951
353959
|
v2Examples: this.convertParameterExamples({
|
|
353952
|
-
schema: parameterSchemaWithExampleOverride ?? schema
|
|
353960
|
+
schema: parameterSchemaWithExampleOverride ?? schema,
|
|
353961
|
+
originalSchema: schema
|
|
353953
353962
|
}),
|
|
353954
353963
|
explode: this.getExplodeForPathParameter()
|
|
353955
353964
|
},
|
|
@@ -353985,7 +353994,7 @@ var init_AbstractParameterConverter = __esm({
|
|
|
353985
353994
|
}
|
|
353986
353995
|
return schema;
|
|
353987
353996
|
}
|
|
353988
|
-
convertParameterExamples({ schema }) {
|
|
353997
|
+
convertParameterExamples({ schema, originalSchema }) {
|
|
353989
353998
|
const v2Examples = {
|
|
353990
353999
|
userSpecifiedExamples: {},
|
|
353991
354000
|
autogeneratedExamples: {}
|
|
@@ -354013,6 +354022,23 @@ var init_AbstractParameterConverter = __esm({
|
|
|
354013
354022
|
exampleName: parameterExampleName
|
|
354014
354023
|
});
|
|
354015
354024
|
}
|
|
354025
|
+
if (Object.keys(v2Examples.userSpecifiedExamples).length === 0) {
|
|
354026
|
+
const schemaExamples = this.context.getExamplesFromSchema({
|
|
354027
|
+
schema: this.resolveSchemaChain(originalSchema),
|
|
354028
|
+
breadcrumbs: this.breadcrumbs
|
|
354029
|
+
});
|
|
354030
|
+
for (const schemaExample of schemaExamples) {
|
|
354031
|
+
const exampleName = this.context.generateUniqueName({
|
|
354032
|
+
prefix: `${this.parameter.name}_example`,
|
|
354033
|
+
existingNames: Object.keys(v2Examples.userSpecifiedExamples)
|
|
354034
|
+
});
|
|
354035
|
+
v2Examples.userSpecifiedExamples[exampleName] = this.generateOrValidateExample({
|
|
354036
|
+
schema,
|
|
354037
|
+
example: this.context.resolveExample(schemaExample),
|
|
354038
|
+
exampleName
|
|
354039
|
+
});
|
|
354040
|
+
}
|
|
354041
|
+
}
|
|
354016
354042
|
if (Object.keys(v2Examples.userSpecifiedExamples).length === 0) {
|
|
354017
354043
|
const exampleName = `${this.parameter.name}_example`;
|
|
354018
354044
|
v2Examples.autogeneratedExamples[exampleName] = this.generateOrValidateExample({
|
|
@@ -354024,6 +354050,26 @@ var init_AbstractParameterConverter = __esm({
|
|
|
354024
354050
|
}
|
|
354025
354051
|
return v2Examples;
|
|
354026
354052
|
}
|
|
354053
|
+
resolveSchemaChain(schemaOrReference) {
|
|
354054
|
+
const visited = /* @__PURE__ */ new Set();
|
|
354055
|
+
let current3 = schemaOrReference;
|
|
354056
|
+
while (this.context.isReferenceObject(current3)) {
|
|
354057
|
+
if (visited.has(current3.$ref)) {
|
|
354058
|
+
return void 0;
|
|
354059
|
+
}
|
|
354060
|
+
visited.add(current3.$ref);
|
|
354061
|
+
const resolved = this.context.resolveReference({
|
|
354062
|
+
reference: current3,
|
|
354063
|
+
breadcrumbs: this.breadcrumbs,
|
|
354064
|
+
skipErrorCollector: true
|
|
354065
|
+
});
|
|
354066
|
+
if (!resolved.resolved) {
|
|
354067
|
+
return void 0;
|
|
354068
|
+
}
|
|
354069
|
+
current3 = resolved.value;
|
|
354070
|
+
}
|
|
354071
|
+
return current3;
|
|
354072
|
+
}
|
|
354027
354073
|
generateOrValidateExample({ schema, example }) {
|
|
354028
354074
|
const exampleConverter = new ExampleConverter({
|
|
354029
354075
|
breadcrumbs: this.breadcrumbs,
|
|
@@ -465839,6 +465885,17 @@ og:description, headline, excerpt).`
|
|
|
465839
465885
|
],
|
|
465840
465886
|
description: "Sets how nested object fields are rendered in the API reference.\n\n@default: `indented`\n\n- `indented` renders each nested level as an indented branch with a connector line and a color-coded path breadcrumb.\n- `cards` renders each nested level as a bordered card."
|
|
465841
465887
|
},
|
|
465888
|
+
"api-reference-expand-properties": {
|
|
465889
|
+
oneOf: [
|
|
465890
|
+
{
|
|
465891
|
+
type: "boolean"
|
|
465892
|
+
},
|
|
465893
|
+
{
|
|
465894
|
+
type: "null"
|
|
465895
|
+
}
|
|
465896
|
+
],
|
|
465897
|
+
description: 'If `api-reference-expand-properties` is set to true, the first level of nested object\nand union fields in the API reference is expanded on page load instead of hidden behind\na "Show N properties" button. Deeper levels stay collapsed. Defaults to false.'
|
|
465898
|
+
},
|
|
465842
465899
|
"show-nav-availability-badges": {
|
|
465843
465900
|
oneOf: [
|
|
465844
465901
|
{
|
|
@@ -706693,7 +706750,7 @@ var AccessTokenPosthogManager = class {
|
|
|
706693
706750
|
properties: {
|
|
706694
706751
|
...event,
|
|
706695
706752
|
...event.properties,
|
|
706696
|
-
version: "5.
|
|
706753
|
+
version: "5.119.1",
|
|
706697
706754
|
usingAccessToken: true,
|
|
706698
706755
|
...getRunIdProperties()
|
|
706699
706756
|
}
|
|
@@ -706759,7 +706816,7 @@ var UserPosthogManager = class {
|
|
|
706759
706816
|
distinctId: this.userId ?? await this.getPersistedDistinctId(),
|
|
706760
706817
|
event: "CLI",
|
|
706761
706818
|
properties: {
|
|
706762
|
-
version: "5.
|
|
706819
|
+
version: "5.119.1",
|
|
706763
706820
|
...event,
|
|
706764
706821
|
...event.properties,
|
|
706765
706822
|
usingAccessToken: false,
|
|
@@ -888437,7 +888494,7 @@ var LOCAL_STORAGE_FOLDER4 = ".fern-dev";
|
|
|
888437
888494
|
var LOGS_FOLDER_NAME = "logs";
|
|
888438
888495
|
var MAX_LOGS_DIR_SIZE_BYTES = 100 * 1024 * 1024;
|
|
888439
888496
|
function getCliSource() {
|
|
888440
|
-
const version7 = "5.
|
|
888497
|
+
const version7 = "5.119.1";
|
|
888441
888498
|
return `cli@${version7}`;
|
|
888442
888499
|
}
|
|
888443
888500
|
var DebugLogger = class {
|
|
@@ -915784,7 +915841,7 @@ var LegacyDocsPublisher = class {
|
|
|
915784
915841
|
previewId,
|
|
915785
915842
|
disableTemplates: void 0,
|
|
915786
915843
|
skipUpload,
|
|
915787
|
-
cliVersion: "5.
|
|
915844
|
+
cliVersion: "5.119.1",
|
|
915788
915845
|
loginCommand: "fern auth login"
|
|
915789
915846
|
});
|
|
915790
915847
|
if (taskContext.getResult() === TaskResult.Failure) {
|
|
@@ -966825,6 +966882,11 @@ var TypescriptCustomConfigSchema = external_exports2.strictObject({
|
|
|
966825
966882
|
tolerateRepublish: external_exports2.optional(external_exports2.boolean()),
|
|
966826
966883
|
packageJson: external_exports2.optional(external_exports2.record(external_exports2.any())),
|
|
966827
966884
|
packageJsonMergeStrategy: external_exports2.optional(external_exports2.enum(["shallow", "deep"])),
|
|
966885
|
+
// When true, the generated SDK compiles cleanly under TypeScript's
|
|
966886
|
+
// `exactOptionalPropertyTypes` compiler option: every optional property is
|
|
966887
|
+
// emitted as `prop?: T | undefined`, and `exactOptionalPropertyTypes: true`
|
|
966888
|
+
// is enabled in the generated tsconfig files.
|
|
966889
|
+
exactOptionalPropertyTypes: external_exports2.optional(external_exports2.boolean()),
|
|
966828
966890
|
publishToJsr: external_exports2.optional(external_exports2.boolean()),
|
|
966829
966891
|
omitUndefined: external_exports2.optional(external_exports2.boolean()),
|
|
966830
966892
|
useLegacyExports: external_exports2.optional(external_exports2.boolean()),
|
|
@@ -983197,7 +983259,7 @@ function getAutomationContextFromEnv() {
|
|
|
983197
983259
|
config_branch: process.env.FERN_CONFIG_BRANCH,
|
|
983198
983260
|
config_pr_number: process.env.FERN_CONFIG_PR_NUMBER,
|
|
983199
983261
|
trigger: process.env.GITHUB_EVENT_NAME,
|
|
983200
|
-
cli_version: "5.
|
|
983262
|
+
cli_version: "5.119.1"
|
|
983201
983263
|
};
|
|
983202
983264
|
}
|
|
983203
983265
|
function isAutomationMode() {
|
|
@@ -984029,7 +984091,7 @@ var CliContext = class _CliContext {
|
|
|
984029
984091
|
if (false) {
|
|
984030
984092
|
this.logger.error("CLI_VERSION is not defined");
|
|
984031
984093
|
}
|
|
984032
|
-
return "5.
|
|
984094
|
+
return "5.119.1";
|
|
984033
984095
|
}
|
|
984034
984096
|
getCliName() {
|
|
984035
984097
|
if (false) {
|
package/package.json
CHANGED