@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
|
@@ -1418,9 +1418,6 @@ var RegisterExampleEndpointCallSchema = z3.object({
|
|
|
1418
1418
|
description: z3.string().nullish(),
|
|
1419
1419
|
name: z3.string().nullish(),
|
|
1420
1420
|
contentType: z3.string().nullish(),
|
|
1421
|
-
// When the request body is a discriminated union and one example is generated per variant,
|
|
1422
|
-
// this carries the variant's discriminant value so the UI can swap examples when the variant changes.
|
|
1423
|
-
discriminant: z3.string().nullish(),
|
|
1424
1421
|
path: z3.string(),
|
|
1425
1422
|
pathParameters: z3.record(PropertyKeySchema, z3.unknown()),
|
|
1426
1423
|
queryParameters: z3.record(z3.string(), z3.unknown()),
|
|
@@ -1994,7 +1991,6 @@ var LatestExampleEndpointCallSchema = z4.object({
|
|
|
1994
1991
|
responseStatusCode: z4.number().int(),
|
|
1995
1992
|
name: z4.string().nullish(),
|
|
1996
1993
|
contentType: z4.string().nullish(),
|
|
1997
|
-
discriminant: z4.string().nullish(),
|
|
1998
1994
|
pathParameters: z4.record(PropertyKeySchema, z4.unknown()).nullish(),
|
|
1999
1995
|
queryParameters: z4.record(PropertyKeySchema, z4.unknown()).nullish(),
|
|
2000
1996
|
headers: z4.record(PropertyKeySchema, z4.unknown()).nullish(),
|
|
@@ -2269,7 +2265,6 @@ var ReadExampleEndpointCallSchema = z5.object({
|
|
|
2269
2265
|
description: z5.string().nullish(),
|
|
2270
2266
|
name: z5.string().nullish(),
|
|
2271
2267
|
contentType: z5.string().nullish(),
|
|
2272
|
-
discriminant: z5.string().nullish(),
|
|
2273
2268
|
path: z5.string(),
|
|
2274
2269
|
pathParameters: z5.record(PropertyKeySchema, z5.unknown()),
|
|
2275
2270
|
queryParameters: z5.record(z5.string(), z5.unknown()),
|
|
@@ -2617,7 +2612,8 @@ var DocsLayoutConfigSchema = z6.object({
|
|
|
2617
2612
|
hideNavLinks: z6.boolean().optional(),
|
|
2618
2613
|
hideFeedback: z6.boolean().optional(),
|
|
2619
2614
|
mobileToc: z6.boolean().optional(),
|
|
2620
|
-
changelogLayout: ChangelogLayoutSchema.optional()
|
|
2615
|
+
changelogLayout: ChangelogLayoutSchema.optional(),
|
|
2616
|
+
showNavAvailabilityBadges: z6.boolean().optional()
|
|
2621
2617
|
});
|
|
2622
2618
|
var FooterNavConfigSchema = z6.enum(["default", "minimal"]);
|
|
2623
2619
|
var DocsSidebarConfigSchema = z6.enum(["default", "minimal"]);
|
|
@@ -2657,7 +2653,13 @@ var HttpSnippetLanguageSchema = z6.enum([
|
|
|
2657
2653
|
var HttpSnippetsConfigSchema = z6.union([z6.boolean(), z6.array(HttpSnippetLanguageSchema)]);
|
|
2658
2654
|
var SearchSettingsConfigSchema = z6.object({
|
|
2659
2655
|
prioritizeCurrentProduct: z6.boolean().optional(),
|
|
2660
|
-
defaultFilterByCurrentProduct: z6.boolean().optional()
|
|
2656
|
+
defaultFilterByCurrentProduct: z6.boolean().optional(),
|
|
2657
|
+
/**
|
|
2658
|
+
* Experimental: absolute URLs of external sitemaps to index alongside this
|
|
2659
|
+
* site's docs content. Their pages are tagged to the same domain but flagged
|
|
2660
|
+
* as third-party so they rank below all first-party documentation in search.
|
|
2661
|
+
*/
|
|
2662
|
+
externalSitemaps: z6.array(z6.string()).optional()
|
|
2661
2663
|
});
|
|
2662
2664
|
var DocsSettingsConfigSchema = z6.object({
|
|
2663
2665
|
searchText: z6.string().optional(),
|
|
@@ -6143,52 +6145,6 @@ function generateHttpRequestBodyExample(type, resolveTypeById) {
|
|
|
6143
6145
|
}
|
|
6144
6146
|
}
|
|
6145
6147
|
}
|
|
6146
|
-
function resolveRequestBodyDiscriminatedUnion(type, resolveTypeById) {
|
|
6147
|
-
let shape;
|
|
6148
|
-
switch (type.type) {
|
|
6149
|
-
case "reference":
|
|
6150
|
-
shape = resolveTypeReferenceToShape(type.value, resolveTypeById, /* @__PURE__ */ new Set());
|
|
6151
|
-
break;
|
|
6152
|
-
case "json":
|
|
6153
|
-
shape = type.shape.type === "reference" ? resolveTypeReferenceToShape(type.shape.value, resolveTypeById, /* @__PURE__ */ new Set()) : void 0;
|
|
6154
|
-
break;
|
|
6155
|
-
default:
|
|
6156
|
-
return void 0;
|
|
6157
|
-
}
|
|
6158
|
-
return shape?.type === "discriminatedUnion" ? shape : void 0;
|
|
6159
|
-
}
|
|
6160
|
-
function resolveTypeReferenceToShape(reference, resolveTypeById, visited) {
|
|
6161
|
-
switch (reference.type) {
|
|
6162
|
-
case "id": {
|
|
6163
|
-
if (visited.has(reference.value)) {
|
|
6164
|
-
return void 0;
|
|
6165
|
-
}
|
|
6166
|
-
visited.add(reference.value);
|
|
6167
|
-
const typeDef = resolveTypeById(reference.value);
|
|
6168
|
-
if (typeDef == null) {
|
|
6169
|
-
return void 0;
|
|
6170
|
-
}
|
|
6171
|
-
if (typeDef.shape.type === "alias") {
|
|
6172
|
-
return resolveTypeReferenceToShape(typeDef.shape.value, resolveTypeById, visited);
|
|
6173
|
-
}
|
|
6174
|
-
return typeDef.shape;
|
|
6175
|
-
}
|
|
6176
|
-
case "optional":
|
|
6177
|
-
case "nullable":
|
|
6178
|
-
return resolveTypeReferenceToShape(reference.itemType, resolveTypeById, visited);
|
|
6179
|
-
default:
|
|
6180
|
-
return void 0;
|
|
6181
|
-
}
|
|
6182
|
-
}
|
|
6183
|
-
function generateDiscriminatedUnionVariantRequestExample(discriminant, variant, resolveTypeById) {
|
|
6184
|
-
return {
|
|
6185
|
-
type: "json",
|
|
6186
|
-
value: {
|
|
6187
|
-
[discriminant]: variant.discriminantValue,
|
|
6188
|
-
...generateExampleObject(variant.additionalProperties, resolveTypeById, true, /* @__PURE__ */ new Set(), 0)
|
|
6189
|
-
}
|
|
6190
|
-
};
|
|
6191
|
-
}
|
|
6192
6148
|
function generateFormDataRequestBodyExample(FormDataRequest, resolveTypeById) {
|
|
6193
6149
|
if (FormDataRequest == null) {
|
|
6194
6150
|
return { type: "form", value: {} };
|
|
@@ -6570,32 +6526,6 @@ function generateEndpointSuccessExample({
|
|
|
6570
6526
|
responseBodyV3: endpointDefinition.response != null ? generateHttpResponseBodyExample(endpointDefinition.response.type, resolveTypeById) : void 0
|
|
6571
6527
|
};
|
|
6572
6528
|
}
|
|
6573
|
-
function generateEndpointSuccessExamples({
|
|
6574
|
-
endpointDefinition,
|
|
6575
|
-
apiDefinition
|
|
6576
|
-
}) {
|
|
6577
|
-
const resolveTypeById = getResolveByTypeId(apiDefinition);
|
|
6578
|
-
const discriminatedUnion11 = endpointDefinition.request != null ? resolveRequestBodyDiscriminatedUnion(endpointDefinition.request.type, resolveTypeById) : void 0;
|
|
6579
|
-
if (discriminatedUnion11 == null || discriminatedUnion11.variants.length <= 1) {
|
|
6580
|
-
return [generateEndpointSuccessExample({ endpointDefinition, apiDefinition })];
|
|
6581
|
-
}
|
|
6582
|
-
const base = generateBaseEndpointExample({ endpointDefinition, apiDefinition, resolveTypeById });
|
|
6583
|
-
const responseBodyV3 = endpointDefinition.response != null ? generateHttpResponseBodyExample(endpointDefinition.response.type, resolveTypeById) : void 0;
|
|
6584
|
-
return discriminatedUnion11.variants.map((variant) => ({
|
|
6585
|
-
...base,
|
|
6586
|
-
// Use `||` (not `??`) so an empty-string displayName falls back to the (always-present,
|
|
6587
|
-
// unique) discriminant value — keeping example names non-empty and distinct.
|
|
6588
|
-
name: variant.displayName || variant.discriminantValue,
|
|
6589
|
-
discriminant: variant.discriminantValue,
|
|
6590
|
-
requestBodyV3: generateDiscriminatedUnionVariantRequestExample(
|
|
6591
|
-
discriminatedUnion11.discriminant,
|
|
6592
|
-
variant,
|
|
6593
|
-
resolveTypeById
|
|
6594
|
-
),
|
|
6595
|
-
responseStatusCode: 200,
|
|
6596
|
-
responseBodyV3
|
|
6597
|
-
}));
|
|
6598
|
-
}
|
|
6599
6529
|
function generateBaseEndpointExample({
|
|
6600
6530
|
endpointDefinition,
|
|
6601
6531
|
apiDefinition,
|
|
@@ -7083,11 +7013,11 @@ function getExampleEndpointCalls({
|
|
|
7083
7013
|
if (registeredSuccessExamples.length > 0) {
|
|
7084
7014
|
examples.push(...registeredSuccessExamples);
|
|
7085
7015
|
} else {
|
|
7086
|
-
const
|
|
7016
|
+
const generatedSuccessExample = generateEndpointSuccessExample({
|
|
7087
7017
|
endpointDefinition: writeShape,
|
|
7088
7018
|
apiDefinition
|
|
7089
7019
|
});
|
|
7090
|
-
examples.push(
|
|
7020
|
+
examples.push(generatedSuccessExample);
|
|
7091
7021
|
}
|
|
7092
7022
|
const registeredErrorExampleStatusCodes = new Set(registeredErrorExamples.map((e) => e.responseStatusCode));
|
|
7093
7023
|
const errorsMissingAnExample = (writeShape.errorsV2 ?? []).filter(
|
|
@@ -7166,7 +7096,6 @@ function transformExampleEndpointCall({
|
|
|
7166
7096
|
return {
|
|
7167
7097
|
name: writeShape.name,
|
|
7168
7098
|
contentType: writeShape.contentType ?? void 0,
|
|
7169
|
-
discriminant: writeShape.discriminant ?? void 0,
|
|
7170
7099
|
description: writeShape.description,
|
|
7171
7100
|
// htmlDescription,
|
|
7172
7101
|
// descriptionContainsMarkdown: true,
|
|
@@ -10085,7 +10014,6 @@ var ApiDefinitionV1ToLatest = class _ApiDefinitionV1ToLatest {
|
|
|
10085
10014
|
responseStatusCode: example?.responseStatusCode,
|
|
10086
10015
|
name: example?.name,
|
|
10087
10016
|
contentType: example?.contentType ?? void 0,
|
|
10088
|
-
discriminant: example?.discriminant ?? void 0,
|
|
10089
10017
|
description: example?.description,
|
|
10090
10018
|
pathParameters: example?.pathParameters,
|
|
10091
10019
|
queryParameters: example?.queryParameters,
|
|
@@ -17366,7 +17294,6 @@ function convertExampleEndpointCall({
|
|
|
17366
17294
|
return {
|
|
17367
17295
|
name: dbShape.name,
|
|
17368
17296
|
contentType: dbShape.contentType ?? void 0,
|
|
17369
|
-
discriminant: dbShape.discriminant ?? void 0,
|
|
17370
17297
|
description: dbShape.description,
|
|
17371
17298
|
// htmlDescription: dbShape.htmlDescription,
|
|
17372
17299
|
// descriptionContainsMarkdown: true,
|