@fern-api/fdr-sdk 1.2.16-3b754a56be → 1.2.16-3bf669ca8e

package/dist/converters/db/examples/generateEndpointExampleCall.js

@@ -0,0 +1,171 @@
+import assertNever from "@fern-api/ui-core-utils/assertNever";
+import { generateExampleFromTypeReference, generateExampleFromTypeShape, generateHttpRequestBodyExample, generateHttpResponseBodyExample } from "./generateHttpBodyExample";
+const MAX_OPTIONAL_EXAMPLES_FOR_QUERY_PARAMS = 2;
+export function generateEndpointErrorExample({ endpointDefinition, apiDefinition, errorDeclaration }) {
+    const resolveTypeById = getResolveByTypeId(apiDefinition);
+    return {
+        ...generateBaseEndpointExample({
+            endpointDefinition,
+            apiDefinition,
+            resolveTypeById
+        }),
+        responseStatusCode: errorDeclaration.statusCode,
+        responseBodyV3: errorDeclaration.type != null
+            ? {
+                type: "json",
+                value: generateExampleFromTypeShape(errorDeclaration.type, resolveTypeById, false, new Set(), 0)
+            }
+            : undefined
+    };
+}
+export function generateEndpointNonStreamResponseExample({ endpointDefinition, apiDefinition, nonStreamResponse }) {
+    const resolveTypeById = getResolveByTypeId(apiDefinition);
+    return {
+        ...generateBaseEndpointExample({
+            endpointDefinition,
+            apiDefinition,
+            resolveTypeById
+        }),
+        responseStatusCode: 200,
+        responseBodyV3: generateHttpResponseBodyExample(nonStreamResponse.shape, resolveTypeById)
+    };
+}
+export function generateEndpointStreamResponseExample({ endpointDefinition, apiDefinition, streamResponse }) {
+    const resolveTypeById = getResolveByTypeId(apiDefinition);
+    return {
+        ...generateBaseEndpointExample({
+            endpointDefinition,
+            apiDefinition,
+            resolveTypeById
+        }),
+        responseStatusCode: 200,
+        responseBodyV3: generateHttpResponseBodyExample(streamResponse.shape, resolveTypeById)
+    };
+}
+export function generateEndpointSuccessExample({ endpointDefinition, apiDefinition }) {
+    const resolveTypeById = getResolveByTypeId(apiDefinition);
+    return {
+        ...generateBaseEndpointExample({
+            endpointDefinition,
+            apiDefinition,
+            resolveTypeById
+        }),
+        responseStatusCode: 200,
+        responseBodyV3: endpointDefinition.response != null
+            ? generateHttpResponseBodyExample(endpointDefinition.response.type, resolveTypeById)
+            : undefined
+    };
+}
+function generateBaseEndpointExample({ endpointDefinition, apiDefinition, resolveTypeById }) {
+    const pathParameters = generatePathParameterExamples({
+        pathParameters: endpointDefinition.path.pathParameters,
+        apiDefinition,
+        resolveTypeById
+    });
+    const path = generatePath(endpointDefinition.path, pathParameters);
+    const queryParameters = generateQueryParameterExamples({
+        resolveTypeById,
+        queryParameters: endpointDefinition.queryParameters
+    });
+    const headers = generateHeaderExamples({
+        headers: [...(apiDefinition.globalHeaders ?? []), ...endpointDefinition.headers],
+        resolveTypeById
+    });
+    const requestBodyV3 = endpointDefinition.request != null
+        ? generateHttpRequestBodyExample(endpointDefinition.request.type, resolveTypeById)
+        : undefined;
+    return {
+        path,
+        pathParameters,
+        queryParameters,
+        headers,
+        requestBodyV3,
+        name: undefined,
+        requestBody: undefined,
+        responseBody: undefined,
+        responseBodyV3: undefined,
+        codeSamples: undefined,
+        description: undefined
+    };
+}
+function generatePathParameterExamples({ pathParameters, apiDefinition, resolveTypeById }) {
+    return pathParameters.reduce((acc, pathParameter) => {
+        const isString = isTypeReferenceString({
+            typeReference: pathParameter.type,
+            types: apiDefinition.types
+        });
+        return {
+            ...acc,
+            [pathParameter.key]: isString
+                ? `:${pathParameter.key}`
+                : generateExampleFromTypeReference(pathParameter.type, resolveTypeById, false, new Set(), 0)
+        };
+    }, {});
+}
+function generateQueryParameterExamples({ queryParameters, resolveTypeById }) {
+    const exampleQueryParameters = {};
+    let optionalCount = 0;
+    for (const queryParameter of queryParameters) {
+        const value = generateExampleFromTypeReference(queryParameter.type, resolveTypeById, optionalCount >= MAX_OPTIONAL_EXAMPLES_FOR_QUERY_PARAMS, new Set(), 0);
+        if (queryParameter.type.type === "optional") {
+            optionalCount += 1;
+        }
+        exampleQueryParameters[queryParameter.key] = value;
+    }
+    return exampleQueryParameters;
+}
+function generateHeaderExamples({ headers, resolveTypeById }) {
+    return headers.reduce((acc, header) => {
+        const value = generateExampleFromTypeReference(header.type, resolveTypeById, false, new Set(), 0);
+        if (value == null) {
+            return acc;
+        }
+        return {
+            ...acc,
+            [header.key]: value
+        };
+    }, {});
+}
+function getResolveByTypeId(apiDefinition) {
+    return (typeId) => {
+        return apiDefinition.types[typeId];
+    };
+}
+function generatePath(path, pathParameters) {
+    let pathString = "";
+    for (const part of path.parts) {
+        switch (part.type) {
+            case "literal":
+                pathString += part.value;
+                break;
+            case "pathParameter":
+                {
+                    const value = pathParameters[part.value];
+                    if (value == null) {
+                        throw new Error("Path parameter is missing: " + part.value);
+                    }
+                    pathString += value;
+                }
+                break;
+            default:
+                assertNever(part);
+        }
+    }
+    return pathString;
+}
+function isTypeReferenceString({ typeReference, types }) {
+    if (typeReference.type === "primitive" && typeReference.value.type === "string") {
+        return true;
+    }
+    else if (typeReference.type === "id") {
+        const typeDef = types[typeReference.value];
+        if (typeDef != null && typeDef.shape.type === "alias") {
+            return isTypeReferenceString({
+                typeReference: typeDef.shape.value,
+                types
+            });
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=generateEndpointExampleCall.js.map

package/dist/converters/db/examples/generateEndpointExampleCall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateEndpointExampleCall.js","sourceRoot":"","sources":["../../../../src/converters/db/examples/generateEndpointExampleCall.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,qCAAqC,CAAC;AAG9D,OAAO,EACH,gCAAgC,EAChC,4BAA4B,EAC5B,8BAA8B,EAC9B,+BAA+B,EAElC,MAAM,2BAA2B,CAAC;AAEnC,MAAM,sCAAsC,GAAG,CAAC,CAAC;AAEjD,MAAM,UAAU,4BAA4B,CAAC,EACzC,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAKnB;IACG,MAAM,eAAe,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAC1D,OAAO;QACH,GAAG,2BAA2B,CAAC;YAC3B,kBAAkB;YAClB,aAAa;YACb,eAAe;SAClB,CAAC;QACF,kBAAkB,EAAE,gBAAgB,CAAC,UAAU;QAC/C,cAAc,EACV,gBAAgB,CAAC,IAAI,IAAI,IAAI;YACzB,CAAC,CAAC;gBACI,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,4BAA4B,CAAC,gBAAgB,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;aACnG;YACH,CAAC,CAAC,SAAS;KACtB,CAAC;AACN,CAAC;AAED,MAAM,UAAU,wCAAwC,CAAC,EACrD,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EAKpB;IACG,MAAM,eAAe,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAC1D,OAAO;QACH,GAAG,2BAA2B,CAAC;YAC3B,kBAAkB;YAClB,aAAa;YACb,eAAe;SAClB,CAAC;QACF,kBAAkB,EAAE,GAAG;QACvB,cAAc,EAAE,+BAA+B,CAAC,iBAAiB,CAAC,KAAK,EAAE,eAAe,CAAC;KAC5F,CAAC;AACN,CAAC;AAED,MAAM,UAAU,qCAAqC,CAAC,EAClD,kBAAkB,EAClB,aAAa,EACb,cAAc,EAKjB;IACG,MAAM,eAAe,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAE1D,OAAO;QACH,GAAG,2BAA2B,CAAC;YAC3B,kBAAkB;YAClB,aAAa;YACb,eAAe;SAClB,CAAC;QACF,kBAAkB,EAAE,GAAG;QACvB,cAAc,EAAE,+BAA+B,CAAC,cAAc,CAAC,KAAK,EAAE,eAAe,CAAC;KACzF,CAAC;AACN,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,EAC3C,kBAAkB,EAClB,aAAa,EAIhB;IACG,MAAM,eAAe,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAC1D,OAAO;QACH,GAAG,2BAA2B,CAAC;YAC3B,kBAAkB;YAClB,aAAa;YACb,eAAe;SAClB,CAAC;QACF,kBAAkB,EAAE,GAAG;QACvB,cAAc,EACV,kBAAkB,CAAC,QAAQ,IAAI,IAAI;YAC/B,CAAC,CAAC,+BAA+B,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;YACpF,CAAC,CAAC,SAAS;KACtB,CAAC;AACN,CAAC;AAED,SAAS,2BAA2B,CAAC,EACjC,kBAAkB,EAClB,aAAa,EACb,eAAe,EAKlB;IACG,MAAM,cAAc,GAAG,6BAA6B,CAAC;QACjD,cAAc,EAAE,kBAAkB,CAAC,IAAI,CAAC,cAAc;QACtD,aAAa;QACb,eAAe;KAClB,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACnE,MAAM,eAAe,GAAG,8BAA8B,CAAC;QACnD,eAAe;QACf,eAAe,EAAE,kBAAkB,CAAC,eAAe;KACtD,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,sBAAsB,CAAC;QACnC,OAAO,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC;QAChF,eAAe;KAClB,CAAC,CAAC;IACH,MAAM,aAAa,GACf,kBAAkB,CAAC,OAAO,IAAI,IAAI;QAC9B,CAAC,CAAC,8BAA8B,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,EAAE,eAAe,CAAC;QAClF,CAAC,CAAC,SAAS,CAAC;IACpB,OAAO;QACH,IAAI;QACJ,cAAc;QACd,eAAe;QACf,OAAO;QACP,aAAa;QAEb,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,SAAS;QACtB,YAAY,EAAE,SAAS;QACvB,cAAc,EAAE,SAAS;QACzB,WAAW,EAAE,SAAS;QACtB,WAAW,EAAE,SAAS;KACzB,CAAC;AACN,CAAC;AAED,SAAS,6BAA6B,CAAC,EACnC,cAAc,EACd,aAAa,EACb,eAAe,EAKlB;IACG,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE;QAChD,MAAM,QAAQ,GAAG,qBAAqB,CAAC;YACnC,aAAa,EAAE,aAAa,CAAC,IAAI;YACjC,KAAK,EAAE,aAAa,CAAC,KAAK;SAC7B,CAAC,CAAC;QACH,OAAO;YACH,GAAG,GAAG;YACN,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,QAAQ;gBACzB,CAAC,CAAC,IAAI,aAAa,CAAC,GAAG,EAAE;gBACzB,CAAC,CAAC,gCAAgC,CAAC,aAAa,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;SACnG,CAAC;IACN,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;AAED,SAAS,8BAA8B,CAAC,EACpC,eAAe,EACf,eAAe,EAIlB;IACG,MAAM,sBAAsB,GAA4B,EAAE,CAAC;IAC3D,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,gCAAgC,CAC1C,cAAc,CAAC,IAAI,EACnB,eAAe,EACf,aAAa,IAAI,sCAAsC,EACvD,IAAI,GAAG,EAAE,EACT,CAAC,CACJ,CAAC;QACF,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC1C,aAAa,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,sBAAsB,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACvD,CAAC;IACD,OAAO,sBAAsB,CAAC;AAClC,CAAC;AAED,SAAS,sBAAsB,CAAC,EAC5B,OAAO,EACP,eAAe,EAIlB;IACG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QAClC,MAAM,KAAK,GAAG,gCAAgC,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;QAClG,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAChB,OAAO,GAAG,CAAC;QACf,CAAC;QACD,OAAO;YACH,GAAG,GAAG;YACN,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK;SACtB,CAAC;IACN,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;AAED,SAAS,kBAAkB,CAAC,aAAuC;IAC/D,OAAO,CAAC,MAAyB,EAAyC,EAAE;QACxE,OAAO,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC,CAAC;AACN,CAAC;AAED,SAAS,YAAY,CAAC,IAA6B,EAAE,cAAuC;IACxF,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,SAAS;gBACV,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC;gBACzB,MAAM;YACV,KAAK,eAAe;gBAChB,CAAC;oBACG,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACzC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;wBAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;oBAChE,CAAC;oBACD,UAAU,IAAI,KAAK,CAAC;gBACxB,CAAC;gBACD,MAAM;YACV;gBACI,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACL,CAAC;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED,SAAS,qBAAqB,CAAC,EAC3B,aAAa,EACb,KAAK,EAIR;IACG,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9E,OAAO,IAAI,CAAC;IAChB,CAAC;SAAM,IAAI,aAAa,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACpD,OAAO,qBAAqB,CAAC;gBACzB,aAAa,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK;gBAClC,KAAK;aACR,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC"}

package/dist/converters/db/examples/generateEndpointExampleCall.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generateEndpointExampleCall.test.d.ts.map

package/dist/converters/db/examples/generateEndpointExampleCall.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateEndpointExampleCall.test.d.ts","sourceRoot":"","sources":["../../../../src/converters/db/examples/generateEndpointExampleCall.test.ts"],"names":[],"mappings":""}

package/dist/converters/db/examples/generateEndpointExampleCall.test.js

@@ -0,0 +1,102 @@
+import { describe, expect, it } from "vitest";
+import { generateEndpointSuccessExample } from "./generateEndpointExampleCall";
+function createMinimalApiDefinition(types = {}) {
+    return {
+        rootPackage: {
+            endpoints: [],
+            webhooks: [],
+            websockets: [],
+            types: [],
+            subpackages: []
+        },
+        subpackages: {},
+        types,
+        globalHeaders: []
+    };
+}
+function createEndpointWithBodyRef(typeId) {
+    return {
+        id: "test-endpoint",
+        method: "POST",
+        path: { parts: [{ type: "literal", value: "/test" }], pathParameters: [] },
+        queryParameters: [],
+        headers: [],
+        request: {
+            type: {
+                type: "json",
+                contentType: "application/json",
+                shape: {
+                    type: "object",
+                    extends: [],
+                    properties: [
+                        {
+                            key: "messages",
+                            valueType: {
+                                type: "id",
+                                value: typeId
+                            }
+                        }
+                    ]
+                }
+            }
+        },
+        examples: []
+    };
+}
+describe("generateEndpointSuccessExample", () => {
+    it("should not throw when a referenced type is missing from the types map", () => {
+        const apiDefinition = createMinimalApiDefinition({});
+        const endpointDefinition = createEndpointWithBodyRef("ChatMessageV2");
+        expect(() => generateEndpointSuccessExample({ endpointDefinition, apiDefinition })).not.toThrow();
+    });
+    it("should return empty object for properties referencing missing types", () => {
+        const apiDefinition = createMinimalApiDefinition({});
+        const endpointDefinition = createEndpointWithBodyRef("MissingType");
+        const result = generateEndpointSuccessExample({ endpointDefinition, apiDefinition });
+        expect(result.requestBodyV3).toEqual({ type: "json", value: {} });
+    });
+    it("should resolve types that exist in the types map", () => {
+        const types = {
+            MyEnum: {
+                name: "MyEnum",
+                shape: {
+                    type: "enum",
+                    values: [{ value: "option_a" }, { value: "option_b" }]
+                }
+            }
+        };
+        const apiDefinition = createMinimalApiDefinition(types);
+        const endpointDefinition = createEndpointWithBodyRef("MyEnum");
+        const result = generateEndpointSuccessExample({ endpointDefinition, apiDefinition });
+        expect(result.requestBodyV3).toEqual({
+            type: "json",
+            value: { messages: "option_a" }
+        });
+    });
+    it("should handle extends referencing a missing type", () => {
+        const types = {
+            MyObject: {
+                name: "MyObject",
+                shape: {
+                    type: "object",
+                    extends: ["MissingBaseType"],
+                    properties: [
+                        {
+                            key: "name",
+                            valueType: { type: "primitive", value: { type: "string" } }
+                        }
+                    ]
+                }
+            }
+        };
+        const apiDefinition = createMinimalApiDefinition(types);
+        const endpointDefinition = createEndpointWithBodyRef("MyObject");
+        expect(() => generateEndpointSuccessExample({ endpointDefinition, apiDefinition })).not.toThrow();
+        const result = generateEndpointSuccessExample({ endpointDefinition, apiDefinition });
+        expect(result.requestBodyV3).toEqual({
+            type: "json",
+            value: { messages: { name: "string" } }
+        });
+    });
+});
+//# sourceMappingURL=generateEndpointExampleCall.test.js.map

package/dist/converters/db/examples/generateEndpointExampleCall.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateEndpointExampleCall.test.js","sourceRoot":"","sources":["../../../../src/converters/db/examples/generateEndpointExampleCall.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAG9C,OAAO,EAAE,8BAA8B,EAAE,MAAM,+BAA+B,CAAC;AAE/E,SAAS,0BAA0B,CAAC,QAAmD,EAAE;IACrF,OAAO;QACH,WAAW,EAAE;YACT,SAAS,EAAE,EAAE;YACb,QAAQ,EAAE,EAAE;YACZ,UAAU,EAAE,EAAE;YACd,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,EAAE;SAClB;QACD,WAAW,EAAE,EAAE;QACf,KAAK;QACL,aAAa,EAAE,EAAE;KACpB,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,MAAc;IAC7C,OAAO;QACH,EAAE,EAAE,eAAwC;QAC5C,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,EAAE,EAAE;QAC1E,eAAe,EAAE,EAAE;QACnB,OAAO,EAAE,EAAE;QACX,OAAO,EAAE;YACL,IAAI,EAAE;gBACF,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,kBAAkB;gBAC/B,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE;oBACX,UAAU,EAAE;wBACR;4BACI,GAAG,EAAE,UAAU;4BACf,SAAS,EAAE;gCACP,IAAI,EAAE,IAAI;gCACV,KAAK,EAAE,MAA2B;6BACrC;yBACJ;qBACJ;iBACJ;aACJ;SACJ;QACD,QAAQ,EAAE,EAAE;KACf,CAAC;AACN,CAAC;AAED,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC7E,MAAM,aAAa,GAAG,0BAA0B,CAAC,EAAE,CAAC,CAAC;QACrD,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,eAAe,CAAC,CAAC;QAEtE,MAAM,CAAC,GAAG,EAAE,CAAC,8BAA8B,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACtG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC3E,MAAM,aAAa,GAAG,0BAA0B,CAAC,EAAE,CAAC,CAAC;QACrD,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEpE,MAAM,MAAM,GAAG,8BAA8B,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,KAAK,GAA8C;YACrD,MAAM,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE;oBACH,IAAI,EAAE,MAAM;oBACZ,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;iBACzD;aACJ;SACJ,CAAC;QACF,MAAM,aAAa,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC;QAE/D,MAAM,MAAM,GAAG,8BAA8B,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;YACjC,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE;SAClC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,KAAK,GAA8C;YACrD,QAAQ,EAAE;gBACN,IAAI,EAAE,UAAU;gBAChB,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,CAAC,iBAAsC,CAAC;oBACjD,UAAU,EAAE;wBACR;4BACI,GAAG,EAAE,MAAM;4BACX,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;yBAC9D;qBACJ;iBACJ;aACJ;SACJ,CAAC;QACF,MAAM,aAAa,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,UAAU,CAAC,CAAC;QAEjE,MAAM,CAAC,GAAG,EAAE,CAAC,8BAA8B,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAElG,MAAM,MAAM,GAAG,8BAA8B,CAAC,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;YACjC,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;SAC1C,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/converters/db/examples/generateHttpBodyExample.d.ts

@@ -0,0 +1,9 @@
+import type { APIV1Write } from "../../../client";
+export type ResolveTypeById = (typeId: APIV1Write.TypeId) => APIV1Write.TypeDefinition | undefined;
+export declare function generateWebhookPayloadExample(shape: APIV1Write.WebhookPayloadShape, resolveTypeById: ResolveTypeById): unknown;
+export declare function generateHttpRequestBodyExample(type: APIV1Write.HttpRequestBodyShape, resolveTypeById: ResolveTypeById): APIV1Write.ExampleEndpointRequest | undefined;
+export declare function generateHttpResponseBodyExample(type: APIV1Write.HttpResponseBodyShape, resolveTypeById: ResolveTypeById): APIV1Write.ExampleEndpointResponse | undefined;
+export declare function generateExampleFromTypeReference(reference: APIV1Write.TypeReference, resolveTypeById: ResolveTypeById, ignoreOptionals: boolean, visited: Set<string>, depth: number): unknown;
+export declare function generateExampleFromTypeShape(shape: APIV1Write.TypeShape, resolveTypeById: ResolveTypeById, ignoreOptionals: boolean, visited: Set<string>, depth: number): unknown;
+export declare function generateExampleFromLiteral(reference: APIV1Write.LiteralType): boolean | string;
+//# sourceMappingURL=generateHttpBodyExample.d.ts.map

package/dist/converters/db/examples/generateHttpBodyExample.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateHttpBodyExample.d.ts","sourceRoot":"","sources":["../../../../src/converters/db/examples/generateHttpBodyExample.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,MAAM,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC,cAAc,GAAG,SAAS,CAAC;AAEnG,wBAAgB,6BAA6B,CACzC,KAAK,EAAE,UAAU,CAAC,mBAAmB,EACrC,eAAe,EAAE,eAAe,GACjC,OAAO,CAWT;AAmCD,wBAAgB,8BAA8B,CAC1C,IAAI,EAAE,UAAU,CAAC,oBAAoB,EACrC,eAAe,EAAE,eAAe,GACjC,UAAU,CAAC,sBAAsB,GAAG,SAAS,CA+B/C;AAiED,wBAAgB,+BAA+B,CAC3C,IAAI,EAAE,UAAU,CAAC,qBAAqB,EACtC,eAAe,EAAE,eAAe,GACjC,UAAU,CAAC,uBAAuB,GAAG,SAAS,CA0ChD;AAyBD,wBAAgB,gCAAgC,CAC5C,SAAS,EAAE,UAAU,CAAC,aAAa,EACnC,eAAe,EAAE,eAAe,EAChC,eAAe,EAAE,OAAO,EACxB,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EACpB,KAAK,EAAE,MAAM,GACd,OAAO,CAkGT;AAgBD,wBAAgB,4BAA4B,CACxC,KAAK,EAAE,UAAU,CAAC,SAAS,EAC3B,eAAe,EAAE,eAAe,EAChC,eAAe,EAAE,OAAO,EACxB,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EACpB,KAAK,EAAE,MAAM,GACd,OAAO,CAkCT;AAED,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,GAAG,OAAO,GAAG,MAAM,CAE9F"}

package/dist/converters/db/examples/generateHttpBodyExample.js

@@ -0,0 +1,344 @@
+import assertNever from "@fern-api/ui-core-utils/assertNever";
+export function generateWebhookPayloadExample(shape, resolveTypeById) {
+    switch (shape.type) {
+        case "object":
+            return generateExampleObject(shape, resolveTypeById, false, new Set(), 0);
+        case "reference":
+            return generateExampleFromTypeReference(shape.value, resolveTypeById, false, new Set(), 0);
+        case "formData":
+            return generateFormDataWebhookPayloadExample(shape, resolveTypeById);
+        default:
+            assertNever(shape);
+    }
+}
+function generateFormDataWebhookPayloadExample(formDataRequest, resolveTypeById) {
+    const example = {};
+    formDataRequest.properties.forEach((property) => {
+        switch (property.type) {
+            case "file": {
+                if (property.value.isOptional) {
+                    break;
+                }
+                if (property.value.type === "fileArray") {
+                    example[property.value.key] = ["<filename1>", "<filename2>"];
+                }
+                else {
+                    example[property.value.key] = "<filename1>";
+                }
+                break;
+            }
+            case "bodyProperty": {
+                example[property.key] = generateExampleFromTypeReference(property.valueType, resolveTypeById, false, new Set(), 0);
+                break;
+            }
+        }
+    });
+    return example;
+}
+export function generateHttpRequestBodyExample(type, resolveTypeById) {
+    switch (type.type) {
+        case "object": {
+            const value = generateExampleObject(type, resolveTypeById, true, new Set(), 0);
+            return { type: "json", value };
+        }
+        case "reference": {
+            // Skip generating synthetic body for unknown types - no meaningful example can be produced
+            if (type.value.type === "unknown") {
+                return undefined;
+            }
+            const value = generateExampleFromTypeReference(type.value, resolveTypeById, true, new Set(), 0);
+            return { type: "json", value };
+        }
+        case "json":
+            return generateHttpJsonRequestBodyExample(type.shape, resolveTypeById);
+        case "fileUpload": // deprecated
+            return generateFormDataRequestBodyExample(type.value ?? undefined, resolveTypeById);
+        case "formData":
+            return generateFormDataRequestBodyExample(type, resolveTypeById);
+        case "bytes": {
+            if (type.isOptional) {
+                return undefined;
+            }
+            let content = btoa("Hello world!");
+            if (type.contentType != null) {
+                content = `data:${type.contentType};base64,${content}`;
+            }
+            return { type: "bytes", value: { type: "base64", value: content } };
+        }
+    }
+}
+function generateFormDataRequestBodyExample(FormDataRequest, resolveTypeById) {
+    if (FormDataRequest == null) {
+        return { type: "form", value: {} }; // old (deprecated) behavior
+    }
+    const example = {};
+    FormDataRequest.properties.forEach((property) => {
+        switch (property.type) {
+            case "file": {
+                if (property.value.isOptional) {
+                    break;
+                }
+                if (property.value.type === "fileArray") {
+                    example[property.value.key] = {
+                        type: "filenames",
+                        value: ["<filename1>", "<filename2>"]
+                    };
+                }
+                else {
+                    example[property.value.key] = {
+                        type: "filename",
+                        value: "<filename1>"
+                    };
+                }
+                break;
+            }
+            case "bodyProperty": {
+                example[property.key] = {
+                    type: "json",
+                    value: generateExampleFromTypeReference(property.valueType, resolveTypeById, true, new Set(), 0)
+                };
+                break;
+            }
+        }
+    });
+    return { type: "form", value: example };
+}
+function generateHttpJsonRequestBodyExample(shape, resolveTypeById) {
+    switch (shape.type) {
+        case "object": {
+            const value = generateExampleObject(shape, resolveTypeById, true, new Set(), 0);
+            return { type: "json", value };
+        }
+        case "reference": {
+            // Skip generating synthetic body for unknown types - no meaningful example can be produced
+            if (shape.value.type === "unknown") {
+                return undefined;
+            }
+            const value = generateExampleFromTypeReference(shape.value, resolveTypeById, true, new Set(), 0);
+            return { type: "json", value };
+        }
+        default:
+            assertNever(shape);
+    }
+}
+export function generateHttpResponseBodyExample(type, resolveTypeById) {
+    switch (type.type) {
+        case "object":
+            return {
+                type: "json",
+                value: generateExampleObject(type, resolveTypeById, false, new Set(), 0)
+            };
+        case "reference":
+            return {
+                type: "json",
+                value: generateExampleFromTypeReference(type.value, resolveTypeById, false, new Set(), 0)
+            };
+        case "fileDownload":
+            return { type: "filename", value: "<filename>" };
+        case "streamingText":
+        case "streamCondition":
+            return { type: "stream", value: ["example-text"] };
+        case "stream": {
+            switch (type.shape.type) {
+                case "object": {
+                    const chunk = generateExampleObject(type.shape, resolveTypeById, false, new Set(), 0);
+                    return {
+                        type: "stream",
+                        value: [chunk, chunk]
+                    };
+                }
+                case "reference": {
+                    const chunk = generateExampleFromTypeReference(type.shape.value, resolveTypeById, false, new Set(), 0);
+                    return {
+                        type: "stream",
+                        value: [chunk, chunk]
+                    };
+                }
+            }
+        }
+    }
+}
+function generateExampleObject(object, resolveTypeById, ignoreOptionals, visited, depth) {
+    const example = {};
+    for (const property of getAllObjectProperties(object, resolveTypeById)) {
+        const value = generateExampleFromTypeReference(property.valueType, resolveTypeById, ignoreOptionals, depth === 0 ? new Set() : new Set(visited), depth + 1);
+        if (value != null) {
+            example[property.key] = value;
+        }
+    }
+    return example;
+}
+export function generateExampleFromTypeReference(reference, resolveTypeById, ignoreOptionals, visited, depth) {
+    let example;
+    switch (reference.type) {
+        case "primitive":
+            example = generateExamplePrimitive(reference.value);
+            break;
+        case "id": {
+            visited.add(reference.value);
+            example = generateExampleFromId(reference.value, resolveTypeById, ignoreOptionals, visited, depth);
+            break;
+        }
+        case "optional":
+            if (reference.itemType.type === "id") {
+                if (visited.has(reference.itemType.value)) {
+                    example = undefined;
+                    break;
+                }
+                else {
+                    visited.add(reference.itemType.value);
+                }
+            }
+            if (ignoreOptionals) {
+                example = undefined;
+            }
+            else {
+                example =
+                    reference.defaultValue ??
+                        generateExampleFromTypeReference(reference.itemType, resolveTypeById, ignoreOptionals, visited, depth);
+            }
+            break;
+        case "nullable":
+            if (reference.itemType.type === "id") {
+                if (visited.has(reference.itemType.value)) {
+                    example = undefined;
+                    break;
+                }
+                else {
+                    visited.add(reference.itemType.value);
+                }
+            }
+            example = generateExampleFromTypeReference(reference.itemType, resolveTypeById, ignoreOptionals, visited, depth);
+            break;
+        case "list":
+            if (reference.itemType.type === "id") {
+                if (visited.has(reference.itemType.value)) {
+                    example = [];
+                    break;
+                }
+                else {
+                    visited.add(reference.itemType.value);
+                }
+            }
+            example = [
+                generateExampleFromTypeReference(reference.itemType, resolveTypeById, ignoreOptionals, visited, depth)
+            ];
+            break;
+        case "set":
+            example = [
+                generateExampleFromTypeReference(reference.itemType, resolveTypeById, ignoreOptionals, visited, depth)
+            ];
+            break;
+        case "map":
+            example = {
+                [generateExampleFromTypeReference(reference.keyType, resolveTypeById, ignoreOptionals, visited, depth + 1)]: generateExampleFromTypeReference(reference.valueType, resolveTypeById, ignoreOptionals, visited, depth + 1)
+            };
+            break;
+        case "unknown":
+            example = {};
+            break;
+        case "literal":
+            example = generateExampleFromLiteral(reference.value);
+            break;
+        default:
+            assertNever(reference);
+    }
+    return example;
+}
+function generateExampleFromId(id, resolveTypeById, ignoreOptionals, visited, depth) {
+    const typeDef = resolveTypeById(id);
+    if (typeDef == null) {
+        return undefined;
+    }
+    return generateExampleFromTypeShape(typeDef.shape, resolveTypeById, ignoreOptionals, visited, depth);
+}
+export function generateExampleFromTypeShape(shape, resolveTypeById, ignoreOptionals, visited, depth) {
+    switch (shape.type) {
+        case "object":
+            return generateExampleObject(shape, resolveTypeById, ignoreOptionals, visited, depth);
+        case "undiscriminatedUnion":
+            if (shape.variants[0] == null) {
+                return {};
+            }
+            return generateExampleFromTypeReference(shape.variants[0].type, resolveTypeById, ignoreOptionals, visited, depth);
+        case "discriminatedUnion":
+            if (shape.variants[0] == null) {
+                return {};
+            }
+            return {
+                [shape.discriminant]: shape.variants[0].discriminantValue,
+                ...generateExampleObject(shape.variants[0].additionalProperties, resolveTypeById, ignoreOptionals, visited, depth)
+            };
+        case "alias":
+            return generateExampleFromTypeReference(shape.value, resolveTypeById, ignoreOptionals, visited, depth);
+        case "enum":
+            return shape.values[0]?.value ?? "";
+    }
+}
+export function generateExampleFromLiteral(reference) {
+    return reference.value;
+}
+function generateExamplePrimitive(reference) {
+    switch (reference.type) {
+        case "string":
+            return "string";
+        case "integer":
+            return 0;
+        case "uint":
+            return 0;
+        case "uint64":
+            return 0;
+        case "double":
+            return 1.0;
+        case "boolean":
+            return true;
+        case "long":
+            return 99999;
+        case "datetime":
+            return "2023-01-01T00:00:00Z";
+        case "uuid":
+            return "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32";
+        case "base64":
+            return "SGVsbG8gV29ybGQ=";
+        case "date":
+            return "2023-01-01";
+        case "bigInteger":
+            return "123456789123456789";
+        case "scalar":
+            return reference.name;
+    }
+}
+function getAllObjectProperties(object, resolveTypeById) {
+    return [
+        ...object.properties,
+        ...object.extends.flatMap((typeId) => {
+            let type = resolveTypeById(typeId);
+            if (type == null) {
+                return [];
+            }
+            if (type.shape.type === "alias" && type.shape.value.type === "id") {
+                type = resolveAlias(type.shape.value.value, resolveTypeById);
+                if (type == null) {
+                    return [];
+                }
+            }
+            if (type.shape.type !== "object") {
+                // Skip non-object types in extends (e.g., primitives or aliases to primitives)
+                // This can occur when converting from OpenAPI where allOf might include non-objects
+                return [];
+            }
+            return getAllObjectProperties(type.shape, resolveTypeById);
+        })
+    ];
+}
+function resolveAlias(typeId, resolveTypeById) {
+    const resolvedTypeDefinition = resolveTypeById(typeId);
+    if (resolvedTypeDefinition == null) {
+        return undefined;
+    }
+    if (resolvedTypeDefinition.shape.type === "alias" && resolvedTypeDefinition.shape.value.type === "id") {
+        return resolveTypeById(resolvedTypeDefinition.shape.value.value);
+    }
+    return resolvedTypeDefinition;
+}
+//# sourceMappingURL=generateHttpBodyExample.js.map