@fern-api/fdr-sdk 1.2.73-d4652c951f → 1.2.74-003639b3c9
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/dist/js/api-definition/index.js +0 -5
- package/dist/js/api-definition/index.js.map +1 -1
- package/dist/js/api-definition/index.mjs +0 -5
- package/dist/js/api-definition/index.mjs.map +1 -1
- package/dist/js/client/FdrClient.js +2033 -1809
- package/dist/js/client/FdrClient.js.map +1 -1
- package/dist/js/client/FdrClient.mjs +2033 -1809
- package/dist/js/client/FdrClient.mjs.map +1 -1
- package/dist/js/client/types.js +9 -7
- package/dist/js/client/types.js.map +1 -1
- package/dist/js/client/types.mjs +9 -7
- package/dist/js/client/types.mjs.map +1 -1
- package/dist/js/converters/index.js +11 -84
- package/dist/js/converters/index.js.map +1 -1
- package/dist/js/converters/index.mjs +11 -84
- package/dist/js/converters/index.mjs.map +1 -1
- package/dist/js/docs/index.js +9 -2
- package/dist/js/docs/index.js.map +1 -1
- package/dist/js/docs/index.mjs +9 -2
- package/dist/js/docs/index.mjs.map +1 -1
- package/dist/js/index.js +2306 -2157
- package/dist/js/index.js.map +1 -1
- package/dist/js/index.mjs +2306 -2157
- package/dist/js/index.mjs.map +1 -1
- package/dist/js/navigation/index.js +9 -8
- package/dist/js/navigation/index.js.map +1 -1
- package/dist/js/navigation/index.mjs +9 -8
- package/dist/js/navigation/index.mjs.map +1 -1
- package/dist/js/orpc-client.js +2308 -2022
- package/dist/js/orpc-client.js.map +1 -1
- package/dist/js/orpc-client.mjs +2275 -2020
- package/dist/js/orpc-client.mjs.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/types/api-definition/migrators/v1ToV2.d.ts +0 -5
- package/dist/types/api-definition/migrators/v1ToV2.d.ts.map +1 -1
- package/dist/types/client/docs-types/db.d.ts +108 -0
- package/dist/types/client/docs-types/db.d.ts.map +1 -1
- package/dist/types/client/docs-types/read.d.ts +48 -0
- package/dist/types/client/docs-types/read.d.ts.map +1 -1
- package/dist/types/client/docs-types/shared.d.ts +21 -0
- package/dist/types/client/docs-types/shared.d.ts.map +1 -1
- package/dist/types/client/docs-types/write.d.ts +28 -0
- package/dist/types/client/docs-types/write.d.ts.map +1 -1
- package/dist/types/converters/db/convertAPIDefinitionToDb.d.ts.map +1 -1
- package/dist/types/converters/db/examples/generateEndpointExampleCall.d.ts +0 -10
- package/dist/types/converters/db/examples/generateEndpointExampleCall.d.ts.map +1 -1
- package/dist/types/converters/db/examples/generateHttpBodyExample.d.ts +0 -10
- package/dist/types/converters/db/examples/generateHttpBodyExample.d.ts.map +1 -1
- package/dist/types/converters/read/convertDbAPIDefinitionToRead.d.ts +0 -14
- package/dist/types/converters/read/convertDbAPIDefinitionToRead.d.ts.map +1 -1
- package/dist/types/navigation/utils/toApis.d.ts +0 -1
- package/dist/types/navigation/utils/toApis.d.ts.map +1 -1
- package/dist/types/orpc-client/api/contract-db.d.ts +0 -500
- package/dist/types/orpc-client/api/contract-db.d.ts.map +1 -1
- package/dist/types/orpc-client/api/contract-latest.d.ts +0 -22
- package/dist/types/orpc-client/api/contract-latest.d.ts.map +1 -1
- package/dist/types/orpc-client/api/contract-read.d.ts +0 -540
- package/dist/types/orpc-client/api/contract-read.d.ts.map +1 -1
- package/dist/types/orpc-client/api/contract-register.d.ts +0 -540
- package/dist/types/orpc-client/api/contract-register.d.ts.map +1 -1
- package/dist/types/orpc-client/client.d.ts +2 -0
- package/dist/types/orpc-client/client.d.ts.map +1 -1
- package/dist/types/orpc-client/dashboard-agent/client.d.ts +13 -0
- package/dist/types/orpc-client/dashboard-agent/client.d.ts.map +1 -0
- package/dist/types/orpc-client/dashboard-agent/contract.d.ts +1444 -0
- package/dist/types/orpc-client/dashboard-agent/contract.d.ts.map +1 -0
- package/dist/types/orpc-client/dashboard-agent/index.d.ts +3 -0
- package/dist/types/orpc-client/dashboard-agent/index.d.ts.map +1 -0
- package/dist/types/orpc-client/docs/v1/read/contract.d.ts +32 -0
- package/dist/types/orpc-client/docs/v1/read/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs/v1/write/contract.d.ts +8 -0
- package/dist/types/orpc-client/docs/v1/write/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs/v2/read/contract.d.ts +72 -0
- package/dist/types/orpc-client/docs/v2/read/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs/v2/write/contract.d.ts +16 -0
- package/dist/types/orpc-client/docs/v2/write/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs-ledger/contract.d.ts +112 -0
- package/dist/types/orpc-client/docs-ledger/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts +72 -28
- package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
- package/dist/types/orpc-client/index.d.ts +1 -0
- package/dist/types/orpc-client/index.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1379,9 +1379,6 @@ var RegisterExampleEndpointCallSchema = z3.object({
|
|
|
1379
1379
|
description: z3.string().nullish(),
|
|
1380
1380
|
name: z3.string().nullish(),
|
|
1381
1381
|
contentType: z3.string().nullish(),
|
|
1382
|
-
// When the request body is a discriminated union and one example is generated per variant,
|
|
1383
|
-
// this carries the variant's discriminant value so the UI can swap examples when the variant changes.
|
|
1384
|
-
discriminant: z3.string().nullish(),
|
|
1385
1382
|
path: z3.string(),
|
|
1386
1383
|
pathParameters: z3.record(PropertyKeySchema, z3.unknown()),
|
|
1387
1384
|
queryParameters: z3.record(z3.string(), z3.unknown()),
|
|
@@ -1955,7 +1952,6 @@ var LatestExampleEndpointCallSchema = z4.object({
|
|
|
1955
1952
|
responseStatusCode: z4.number().int(),
|
|
1956
1953
|
name: z4.string().nullish(),
|
|
1957
1954
|
contentType: z4.string().nullish(),
|
|
1958
|
-
discriminant: z4.string().nullish(),
|
|
1959
1955
|
pathParameters: z4.record(PropertyKeySchema, z4.unknown()).nullish(),
|
|
1960
1956
|
queryParameters: z4.record(PropertyKeySchema, z4.unknown()).nullish(),
|
|
1961
1957
|
headers: z4.record(PropertyKeySchema, z4.unknown()).nullish(),
|
|
@@ -2230,7 +2226,6 @@ var ReadExampleEndpointCallSchema = z5.object({
|
|
|
2230
2226
|
description: z5.string().nullish(),
|
|
2231
2227
|
name: z5.string().nullish(),
|
|
2232
2228
|
contentType: z5.string().nullish(),
|
|
2233
|
-
discriminant: z5.string().nullish(),
|
|
2234
2229
|
path: z5.string(),
|
|
2235
2230
|
pathParameters: z5.record(PropertyKeySchema, z5.unknown()),
|
|
2236
2231
|
queryParameters: z5.record(z5.string(), z5.unknown()),
|
|
@@ -2578,7 +2573,8 @@ var DocsLayoutConfigSchema = z6.object({
|
|
|
2578
2573
|
hideNavLinks: z6.boolean().optional(),
|
|
2579
2574
|
hideFeedback: z6.boolean().optional(),
|
|
2580
2575
|
mobileToc: z6.boolean().optional(),
|
|
2581
|
-
changelogLayout: ChangelogLayoutSchema.optional()
|
|
2576
|
+
changelogLayout: ChangelogLayoutSchema.optional(),
|
|
2577
|
+
showNavAvailabilityBadges: z6.boolean().optional()
|
|
2582
2578
|
});
|
|
2583
2579
|
var FooterNavConfigSchema = z6.enum(["default", "minimal"]);
|
|
2584
2580
|
var DocsSidebarConfigSchema = z6.enum(["default", "minimal"]);
|
|
@@ -2618,7 +2614,13 @@ var HttpSnippetLanguageSchema = z6.enum([
|
|
|
2618
2614
|
var HttpSnippetsConfigSchema = z6.union([z6.boolean(), z6.array(HttpSnippetLanguageSchema)]);
|
|
2619
2615
|
var SearchSettingsConfigSchema = z6.object({
|
|
2620
2616
|
prioritizeCurrentProduct: z6.boolean().optional(),
|
|
2621
|
-
defaultFilterByCurrentProduct: z6.boolean().optional()
|
|
2617
|
+
defaultFilterByCurrentProduct: z6.boolean().optional(),
|
|
2618
|
+
/**
|
|
2619
|
+
* Experimental: absolute URLs of external sitemaps to index alongside this
|
|
2620
|
+
* site's docs content. Their pages are tagged to the same domain but flagged
|
|
2621
|
+
* as third-party so they rank below all first-party documentation in search.
|
|
2622
|
+
*/
|
|
2623
|
+
externalSitemaps: z6.array(z6.string()).optional()
|
|
2622
2624
|
});
|
|
2623
2625
|
var DocsSettingsConfigSchema = z6.object({
|
|
2624
2626
|
searchText: z6.string().optional(),
|
|
@@ -6104,52 +6106,6 @@ function generateHttpRequestBodyExample(type, resolveTypeById) {
|
|
|
6104
6106
|
}
|
|
6105
6107
|
}
|
|
6106
6108
|
}
|
|
6107
|
-
function resolveRequestBodyDiscriminatedUnion(type, resolveTypeById) {
|
|
6108
|
-
let shape;
|
|
6109
|
-
switch (type.type) {
|
|
6110
|
-
case "reference":
|
|
6111
|
-
shape = resolveTypeReferenceToShape(type.value, resolveTypeById, /* @__PURE__ */ new Set());
|
|
6112
|
-
break;
|
|
6113
|
-
case "json":
|
|
6114
|
-
shape = type.shape.type === "reference" ? resolveTypeReferenceToShape(type.shape.value, resolveTypeById, /* @__PURE__ */ new Set()) : void 0;
|
|
6115
|
-
break;
|
|
6116
|
-
default:
|
|
6117
|
-
return void 0;
|
|
6118
|
-
}
|
|
6119
|
-
return shape?.type === "discriminatedUnion" ? shape : void 0;
|
|
6120
|
-
}
|
|
6121
|
-
function resolveTypeReferenceToShape(reference, resolveTypeById, visited) {
|
|
6122
|
-
switch (reference.type) {
|
|
6123
|
-
case "id": {
|
|
6124
|
-
if (visited.has(reference.value)) {
|
|
6125
|
-
return void 0;
|
|
6126
|
-
}
|
|
6127
|
-
visited.add(reference.value);
|
|
6128
|
-
const typeDef = resolveTypeById(reference.value);
|
|
6129
|
-
if (typeDef == null) {
|
|
6130
|
-
return void 0;
|
|
6131
|
-
}
|
|
6132
|
-
if (typeDef.shape.type === "alias") {
|
|
6133
|
-
return resolveTypeReferenceToShape(typeDef.shape.value, resolveTypeById, visited);
|
|
6134
|
-
}
|
|
6135
|
-
return typeDef.shape;
|
|
6136
|
-
}
|
|
6137
|
-
case "optional":
|
|
6138
|
-
case "nullable":
|
|
6139
|
-
return resolveTypeReferenceToShape(reference.itemType, resolveTypeById, visited);
|
|
6140
|
-
default:
|
|
6141
|
-
return void 0;
|
|
6142
|
-
}
|
|
6143
|
-
}
|
|
6144
|
-
function generateDiscriminatedUnionVariantRequestExample(discriminant, variant, resolveTypeById) {
|
|
6145
|
-
return {
|
|
6146
|
-
type: "json",
|
|
6147
|
-
value: {
|
|
6148
|
-
[discriminant]: variant.discriminantValue,
|
|
6149
|
-
...generateExampleObject(variant.additionalProperties, resolveTypeById, true, /* @__PURE__ */ new Set(), 0)
|
|
6150
|
-
}
|
|
6151
|
-
};
|
|
6152
|
-
}
|
|
6153
6109
|
function generateFormDataRequestBodyExample(FormDataRequest, resolveTypeById) {
|
|
6154
6110
|
if (FormDataRequest == null) {
|
|
6155
6111
|
return { type: "form", value: {} };
|
|
@@ -6531,32 +6487,6 @@ function generateEndpointSuccessExample({
|
|
|
6531
6487
|
responseBodyV3: endpointDefinition.response != null ? generateHttpResponseBodyExample(endpointDefinition.response.type, resolveTypeById) : void 0
|
|
6532
6488
|
};
|
|
6533
6489
|
}
|
|
6534
|
-
function generateEndpointSuccessExamples({
|
|
6535
|
-
endpointDefinition,
|
|
6536
|
-
apiDefinition
|
|
6537
|
-
}) {
|
|
6538
|
-
const resolveTypeById = getResolveByTypeId(apiDefinition);
|
|
6539
|
-
const discriminatedUnion11 = endpointDefinition.request != null ? resolveRequestBodyDiscriminatedUnion(endpointDefinition.request.type, resolveTypeById) : void 0;
|
|
6540
|
-
if (discriminatedUnion11 == null || discriminatedUnion11.variants.length <= 1) {
|
|
6541
|
-
return [generateEndpointSuccessExample({ endpointDefinition, apiDefinition })];
|
|
6542
|
-
}
|
|
6543
|
-
const base = generateBaseEndpointExample({ endpointDefinition, apiDefinition, resolveTypeById });
|
|
6544
|
-
const responseBodyV3 = endpointDefinition.response != null ? generateHttpResponseBodyExample(endpointDefinition.response.type, resolveTypeById) : void 0;
|
|
6545
|
-
return discriminatedUnion11.variants.map((variant) => ({
|
|
6546
|
-
...base,
|
|
6547
|
-
// Use `||` (not `??`) so an empty-string displayName falls back to the (always-present,
|
|
6548
|
-
// unique) discriminant value — keeping example names non-empty and distinct.
|
|
6549
|
-
name: variant.displayName || variant.discriminantValue,
|
|
6550
|
-
discriminant: variant.discriminantValue,
|
|
6551
|
-
requestBodyV3: generateDiscriminatedUnionVariantRequestExample(
|
|
6552
|
-
discriminatedUnion11.discriminant,
|
|
6553
|
-
variant,
|
|
6554
|
-
resolveTypeById
|
|
6555
|
-
),
|
|
6556
|
-
responseStatusCode: 200,
|
|
6557
|
-
responseBodyV3
|
|
6558
|
-
}));
|
|
6559
|
-
}
|
|
6560
6490
|
function generateBaseEndpointExample({
|
|
6561
6491
|
endpointDefinition,
|
|
6562
6492
|
apiDefinition,
|
|
@@ -7044,11 +6974,11 @@ function getExampleEndpointCalls({
|
|
|
7044
6974
|
if (registeredSuccessExamples.length > 0) {
|
|
7045
6975
|
examples.push(...registeredSuccessExamples);
|
|
7046
6976
|
} else {
|
|
7047
|
-
const
|
|
6977
|
+
const generatedSuccessExample = generateEndpointSuccessExample({
|
|
7048
6978
|
endpointDefinition: writeShape,
|
|
7049
6979
|
apiDefinition
|
|
7050
6980
|
});
|
|
7051
|
-
examples.push(
|
|
6981
|
+
examples.push(generatedSuccessExample);
|
|
7052
6982
|
}
|
|
7053
6983
|
const registeredErrorExampleStatusCodes = new Set(registeredErrorExamples.map((e) => e.responseStatusCode));
|
|
7054
6984
|
const errorsMissingAnExample = (writeShape.errorsV2 ?? []).filter(
|
|
@@ -7127,7 +7057,6 @@ function transformExampleEndpointCall({
|
|
|
7127
7057
|
return {
|
|
7128
7058
|
name: writeShape.name,
|
|
7129
7059
|
contentType: writeShape.contentType ?? void 0,
|
|
7130
|
-
discriminant: writeShape.discriminant ?? void 0,
|
|
7131
7060
|
description: writeShape.description,
|
|
7132
7061
|
// htmlDescription,
|
|
7133
7062
|
// descriptionContainsMarkdown: true,
|
|
@@ -10046,7 +9975,6 @@ var ApiDefinitionV1ToLatest = class _ApiDefinitionV1ToLatest {
|
|
|
10046
9975
|
responseStatusCode: example?.responseStatusCode,
|
|
10047
9976
|
name: example?.name,
|
|
10048
9977
|
contentType: example?.contentType ?? void 0,
|
|
10049
|
-
discriminant: example?.discriminant ?? void 0,
|
|
10050
9978
|
description: example?.description,
|
|
10051
9979
|
pathParameters: example?.pathParameters,
|
|
10052
9980
|
queryParameters: example?.queryParameters,
|
|
@@ -17327,7 +17255,6 @@ function convertExampleEndpointCall({
|
|
|
17327
17255
|
return {
|
|
17328
17256
|
name: dbShape.name,
|
|
17329
17257
|
contentType: dbShape.contentType ?? void 0,
|
|
17330
|
-
discriminant: dbShape.discriminant ?? void 0,
|
|
17331
17258
|
description: dbShape.description,
|
|
17332
17259
|
// htmlDescription: dbShape.htmlDescription,
|
|
17333
17260
|
// descriptionContainsMarkdown: true,
|