@fern-api/fdr-sdk 0.142.19-3b47d0de4 → 0.142.19-5a63575ba

package/dist/api-definition/sort-keys.js

@@ -0,0 +1,103 @@
+import isPlainObject from "@fern-api/ui-core-utils/isPlainObject";
+import visitDiscriminatedUnion from "@fern-api/ui-core-utils/visitDiscriminatedUnion";
+import { difference, keyBy } from "es-toolkit/array";
+import { mapValues } from "es-toolkit/object";
+import { unwrapDiscriminatedUnionVariant, unwrapObjectType } from "./unwrap";
+function sortKeysBy(obj, order) {
+    return mapValues(
+    // difference() is used to ensure that all keys are included in the result
+    keyBy([...order, ...difference(Object.keys(obj), order)], (key) => key), (key) => obj[key]);
+}
+export function sortKeysByShape(obj, shape, types) {
+    if ((!isPlainObject(obj) && !Array.isArray(obj)) || shape == null) {
+        return obj;
+    }
+    return visitDiscriminatedUnion(shape, "type")._visit({
+        id: ({ id }) => sortKeysByShape(obj, types[id]?.shape, types),
+        primitive: () => obj,
+        literal: () => obj,
+        optional: ({ shape }) => sortKeysByShape(obj, shape, types),
+        nullable: ({ shape }) => sortKeysByShape(obj, shape, types),
+        list: ({ itemShape }) => (Array.isArray(obj) ? obj.map((o) => sortKeysByShape(o, itemShape, types)) : obj),
+        set: ({ itemShape }) => (Array.isArray(obj) ? obj.map((o) => sortKeysByShape(o, itemShape, types)) : obj),
+        map: ({ valueShape }) => isPlainObject(obj) ? mapValues(obj, (value) => sortKeysByShape(value, valueShape, types)) : obj,
+        unknown: () => obj,
+        object: (object) => {
+            const objectProperties = unwrapObjectType(object, types).properties;
+            return isPlainObject(obj)
+                ? mapValues(sortKeysBy(obj, objectProperties.map((p) => p.key)), (value, key) => {
+                    const property = objectProperties.find((p) => p.key === key);
+                    if (property == null) {
+                        return value;
+                    }
+                    return sortKeysByShape(value, property?.valueShape, types);
+                })
+                : obj;
+        },
+        undiscriminatedUnion: () => obj, // TODO: match variant and sort nested objects
+        discriminatedUnion: (union) => {
+            const { discriminant, variants } = union;
+            if (!isPlainObject(obj)) {
+                return obj;
+            }
+            const variant = obj[discriminant];
+            if (variant == null) {
+                return obj;
+            }
+            const variantShape = variants.find((v) => v.discriminantValue === variant);
+            if (variantShape == null) {
+                return obj;
+            }
+            const variantProperties = unwrapDiscriminatedUnionVariant(union, variantShape, types).properties;
+            return mapValues(sortKeysBy(obj, [discriminant, ...variantProperties.map((p) => p.key)]), (value, key) => {
+                if (key === discriminant) {
+                    return value;
+                }
+                const property = variantProperties.find((p) => p.key === key);
+                if (property == null) {
+                    return value;
+                }
+                return sortKeysByShape(value, property.valueShape, types);
+            });
+        },
+        enum: () => obj,
+        alias: ({ value: typeRef }) => sortKeysByShape(obj, typeRef, types),
+        formData: ({ fields }) => {
+            if (!isPlainObject(obj)) {
+                return obj;
+            }
+            return mapValues(sortKeysBy(obj, fields.map((p) => p.key)), (v, key) => {
+                const property = fields.find((p) => p.key === key);
+                if (property == null) {
+                    return v;
+                }
+                if (property.type === "property") {
+                    return sortKeysByShape(v, property.valueShape, types);
+                }
+                return undefined;
+            });
+        },
+        bytes: () => obj,
+        fileDownload: () => obj,
+        streamingText: () => obj,
+        stream: () => obj,
+        empty: () => obj,
+        _other: () => obj
+    });
+}
+export function safeSortKeysByShape(value, shape, types) {
+    if (value == null) {
+        return value;
+    }
+    try {
+        return stripUndefines(sortKeysByShape(value, shape, types));
+    }
+    catch (e) {
+        console.error("Failed to sort JSON keys by type shape", e);
+        return value;
+    }
+}
+function stripUndefines(obj) {
+    return JSON.parse(JSON.stringify(obj));
+}
+//# sourceMappingURL=sort-keys.js.map

package/dist/api-definition/sort-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-keys.js","sourceRoot":"","sources":["../../src/api-definition/sort-keys.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,uBAAuB,MAAM,iDAAiD,CAAC;AACtF,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAI9C,OAAO,EAAE,+BAA+B,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE7E,SAAS,UAAU,CAAC,GAA4B,EAAE,KAAe;IAC7D,OAAO,SAAS;IACZ,0EAA0E;IAC1E,KAAK,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EACvE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CACpB,CAAC;AACN,CAAC;AAED,MAAM,UAAU,eAAe,CAC3B,GAAY,EACZ,KAA2G,EAC3G,KAA4C;IAE5C,IAAI,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChE,OAAO,GAAG,CAAC;IACf,CAAC;IACD,OAAO,uBAAuB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,MAAM,CAAU;QAC1D,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;QAC7D,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG;QACpB,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG;QAClB,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC;QAC3D,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC;QAC3D,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAC1G,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACzG,GAAG,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CACpB,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;QACnG,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG;QAClB,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;YACf,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC;YACpE,OAAO,aAAa,CAAC,GAAG,CAAC;gBACrB,CAAC,CAAC,SAAS,CACL,UAAU,CACN,GAAG,EACH,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CACrC,EACD,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBACX,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;oBAC7D,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;wBACnB,OAAO,KAAK,CAAC;oBACjB,CAAC;oBACD,OAAO,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;gBAC/D,CAAC,CACJ;gBACH,CAAC,CAAC,GAAG,CAAC;QACd,CAAC;QACD,oBAAoB,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,8CAA8C;QAC/E,kBAAkB,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1B,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;YACzC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,OAAO,GAAG,CAAC;YACf,CAAC;YACD,MAAM,OAAO,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;YAClC,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBAClB,OAAO,GAAG,CAAC;YACf,CAAC;YACD,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,KAAK,OAAO,CAAC,CAAC;YAC3E,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC;YACf,CAAC;YACD,MAAM,iBAAiB,GAAG,+BAA+B,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC;YACjG,OAAO,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACrG,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;oBACvB,OAAO,KAAK,CAAC;gBACjB,CAAC;gBACD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;gBAC9D,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;oBACnB,OAAO,KAAK,CAAC;gBACjB,CAAC;gBACD,OAAO,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;QACP,CAAC;QACD,IAAI,EAAE,GAAG,EAAE,CAAC,GAAG;QACf,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC;QACnE,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;YACrB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,OAAO,GAAG,CAAC;YACf,CAAC;YAED,OAAO,SAAS,CACZ,UAAU,CACN,GAAG,EACH,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAC3B,EACD,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;gBACP,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;gBAEnD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;oBACnB,OAAO,CAAC,CAAC;gBACb,CAAC;gBAED,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBAC/B,OAAO,eAAe,CAAC,CAAC,EAAE,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;gBAC1D,CAAC;gBAED,OAAO,SAAS,CAAC;YACrB,CAAC,CACJ,CAAC;QACN,CAAC;QACD,KAAK,EAAE,GAAG,EAAE,CAAC,GAAG;QAChB,YAAY,EAAE,GAAG,EAAE,CAAC,GAAG;QACvB,aAAa,EAAE,GAAG,EAAE,CAAC,GAAG;QACxB,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG;QACjB,KAAK,EAAE,GAAG,EAAE,CAAC,GAAG;QAChB,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG;KACpB,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,mBAAmB,CAC/B,KAAc,EACd,KAA2G,EAC3G,KAA4C;IAE5C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,IAAI,CAAC;QACD,OAAO,cAAc,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,CAAC,CAAC,CAAC;QAE3D,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,SAAS,cAAc,CAAC,GAAY;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3C,CAAC"}

package/dist/api-definition/status-message.d.ts

@@ -0,0 +1,9 @@
+import type { HttpMethod } from "./latest";
+type StatusCodeMessagesByMethod = Partial<Record<HttpMethod, string>>;
+type StatusCodeMessages = Record<number, StatusCodeMessagesByMethod>;
+type DefaultStatusCodeMessages = Record<number, string>;
+export declare const STATUS_CODE_MESSAGES: DefaultStatusCodeMessages;
+export declare const STATUS_CODE_MESSAGES_METHOD_OVERRIDES: StatusCodeMessages;
+export declare function getMessageForStatus(statusCode: number, method?: HttpMethod): string;
+export {};
+//# sourceMappingURL=status-message.d.ts.map

package/dist/api-definition/status-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"status-message.d.ts","sourceRoot":"","sources":["../../src/api-definition/status-message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,KAAK,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AAEtE,KAAK,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;AAErE,KAAK,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAExD,eAAO,MAAM,oBAAoB,EAAE,yBAgElC,CAAC;AAEF,eAAO,MAAM,qCAAqC,EAAE,kBAQnD,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAgCnF"}

package/dist/api-definition/status-message.js

@@ -0,0 +1,111 @@
+export const STATUS_CODE_MESSAGES = {
+    100: "Continue",
+    101: "Switching Protocols",
+    102: "Processing",
+    103: "Early Hints",
+    200: "OK",
+    201: "Created",
+    202: "Accepted",
+    203: "Non-Authoritative Information",
+    204: "No Content",
+    205: "Reset Content",
+    206: "Partial Content",
+    207: "Multi-Status",
+    208: "Already Reported",
+    226: "IM Used",
+    300: "Multiple Choices",
+    301: "Moved Permanently",
+    302: "Found",
+    303: "See Other",
+    304: "Not Modified",
+    305: "Use Proxy",
+    306: "Switch Proxy",
+    307: "Temporary Redirect",
+    308: "Permanent Redirect",
+    400: "Bad Request",
+    401: "Unauthorized",
+    402: "Payment Required",
+    403: "Forbidden",
+    404: "Not Found",
+    405: "Method Not Allowed",
+    406: "Not Acceptable",
+    407: "Proxy Authentication Required",
+    408: "Request Timeout",
+    409: "Conflict",
+    410: "Gone",
+    411: "Length Required",
+    412: "Precondition Failed",
+    413: "Payload Too Large",
+    414: "URI Too Long",
+    415: "Unsupported Media Type",
+    416: "Range Not Satisfiable",
+    417: "Expectation Failed",
+    418: "I'm a teapot",
+    421: "Misdirected Request",
+    422: "Unprocessable Entity",
+    423: "Locked",
+    424: "Failed Dependency",
+    425: "Too Early",
+    426: "Upgrade Required",
+    428: "Precondition Required",
+    429: "Too Many Requests",
+    431: "Request Header Fields Too Large",
+    451: "Unavailable For Legal Reasons",
+    500: "Internal Server Error",
+    501: "Not Implemented",
+    502: "Bad Gateway",
+    503: "Service Unavailable",
+    504: "Gateway Timeout",
+    505: "HTTP Version Not Supported",
+    506: "Variant Also Negotiates",
+    507: "Insufficient Storage",
+    508: "Loop Detected",
+    510: "Not Extended",
+    511: "Network Authentication Required"
+};
+export const STATUS_CODE_MESSAGES_METHOD_OVERRIDES = {
+    200: {
+        GET: "Retrieved",
+        POST: "Successful", // more accurate than "Created" for POST
+        PUT: "Updated",
+        PATCH: "Updated",
+        DELETE: "Deleted"
+    }
+};
+export function getMessageForStatus(statusCode, method) {
+    // return the method-specific message if it exists
+    if (method != null) {
+        const methodOverrides = STATUS_CODE_MESSAGES_METHOD_OVERRIDES[statusCode];
+        if (methodOverrides != null) {
+            const message = methodOverrides[method];
+            if (message != null) {
+                return message;
+            }
+        }
+    }
+    // return the official status message if it exists
+    const message = STATUS_CODE_MESSAGES[statusCode];
+    if (message != null) {
+        return message;
+    }
+    // return the default message if it exists
+    if (statusCode >= 100 && statusCode < 200) {
+        return "Informational";
+    }
+    else if (statusCode >= 200 && statusCode < 300) {
+        return "Success";
+    }
+    else if (statusCode >= 300 && statusCode < 400) {
+        return "Redirection";
+    }
+    else if (statusCode >= 400 && statusCode < 500) {
+        return "Client Error";
+    }
+    else if (statusCode >= 500 && statusCode < 600) {
+        return "Server Error";
+    }
+    else {
+        return "Unknown Status";
+    }
+}
+//# sourceMappingURL=status-message.js.map

package/dist/api-definition/status-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status-message.js","sourceRoot":"","sources":["../../src/api-definition/status-message.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,oBAAoB,GAA8B;IAC3D,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,YAAY;IACjB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,+BAA+B;IACpC,GAAG,EAAE,YAAY;IACjB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,gBAAgB;IACrB,GAAG,EAAE,+BAA+B;IACpC,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,wBAAwB;IAC7B,GAAG,EAAE,uBAAuB;IAC5B,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,QAAQ;IACb,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,uBAAuB;IAC5B,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,iCAAiC;IACtC,GAAG,EAAE,+BAA+B;IACpC,GAAG,EAAE,uBAAuB;IAC5B,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,4BAA4B;IACjC,GAAG,EAAE,yBAAyB;IAC9B,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,iCAAiC;CACzC,CAAC;AAEF,MAAM,CAAC,MAAM,qCAAqC,GAAuB;IACrE,GAAG,EAAE;QACD,GAAG,EAAE,WAAW;QAChB,IAAI,EAAE,YAAY,EAAE,wCAAwC;QAC5D,GAAG,EAAE,SAAS;QACd,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,SAAS;KACpB;CACJ,CAAC;AAEF,MAAM,UAAU,mBAAmB,CAAC,UAAkB,EAAE,MAAmB;IACvE,kDAAkD;IAClD,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,eAAe,GAAG,qCAAqC,CAAC,UAAU,CAAC,CAAC;QAC1E,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;YAC1B,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBAClB,OAAO,OAAO,CAAC;YACnB,CAAC;QACL,CAAC;IACL,CAAC;IAED,kDAAkD;IAClD,MAAM,OAAO,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;IACjD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,0CAA0C;IAC1C,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;QACxC,OAAO,eAAe,CAAC;IAC3B,CAAC;SAAM,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;QAC/C,OAAO,SAAS,CAAC;IACrB,CAAC;SAAM,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;QAC/C,OAAO,aAAa,CAAC;IACzB,CAAC;SAAM,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;QAC/C,OAAO,cAAc,CAAC;IAC1B,CAAC;SAAM,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;QAC/C,OAAO,cAAc,CAAC;IAC1B,CAAC;SAAM,CAAC;QACJ,OAAO,gBAAgB,CAAC;IAC5B,CAAC;AACL,CAAC"}

package/dist/api-definition/transformer.d.ts

@@ -0,0 +1,66 @@
+import type * as Latest from "./latest";
+/**
+ * Visitor for API definitions.
+ * This is used to traverse the API definition and apply functions to each node.
+ */
+export interface ApiDefinitionVisitor {
+    EndpointDefinition(endpoint: Latest.EndpointDefinition, key: string): Latest.EndpointDefinition;
+    HttpRequest(request: Latest.HttpRequest, key: string): Latest.HttpRequest;
+    HttpResponse(response: Latest.HttpResponse, key: string): Latest.HttpResponse;
+    ErrorResponse(error: Latest.ErrorResponse, key: string): Latest.ErrorResponse;
+    ExampleEndpointCall(example: Latest.ExampleEndpointCall, key: string): Latest.ExampleEndpointCall;
+    CodeSnippet(snippet: Latest.CodeSnippet, key: string): Latest.CodeSnippet;
+    ErrorExample(error: Latest.ErrorExample, key: string): Latest.ErrorExample;
+    WebhookDefinition(webhook: Latest.WebhookDefinition, key: string): Latest.WebhookDefinition;
+    WebhookPayload(payload: Latest.WebhookPayload, key: string): Latest.WebhookPayload;
+    WebSocketChannel(channel: Latest.WebSocketChannel, key: string): Latest.WebSocketChannel;
+    WebSocketMessage(message: Latest.WebSocketMessage, key: string): Latest.WebSocketMessage;
+    ExampleWebSocketSession(session: Latest.ExampleWebSocketSession, key: string): Latest.ExampleWebSocketSession;
+    TypeDefinition(type: Latest.TypeDefinition, key: string): Latest.TypeDefinition;
+    TypeShape(shape: Latest.TypeShape, key: string): Latest.TypeShape;
+    ObjectType(property: Latest.ObjectType, key: string): Latest.ObjectType;
+    ObjectProperty(property: Latest.ObjectProperty, key: string): Latest.ObjectProperty;
+    EnumValue(value: Latest.EnumValue, key: string): Latest.EnumValue;
+    UndiscriminatedUnionVariant(variant: Latest.UndiscriminatedUnionVariant, key: string): Latest.UndiscriminatedUnionVariant;
+    DiscriminatedUnionVariant(variant: Latest.DiscriminatedUnionVariant, key: string): Latest.DiscriminatedUnionVariant;
+    FormDataRequest(request: Latest.FormDataRequest, key: string): Latest.FormDataRequest;
+    FormDataField(field: Latest.FormDataField, key: string): Latest.FormDataField;
+    FormDataFile(file: Latest.FormDataFile, key: string): Latest.FormDataFile;
+    FormDataFiles(files: Latest.FormDataFiles, key: string): Latest.FormDataFiles;
+}
+export declare class Transformer {
+    #private;
+    static with(visitor: Partial<ApiDefinitionVisitor>): Transformer;
+    static descriptions(transformer: (description: string, key: string) => string): Transformer;
+    /**
+     * @internal visible for testing only
+     */
+    static keys(collect: (key: string) => void): Transformer;
+    private visitor;
+    private constructor();
+    /**
+     * Visits an API definition and applies the visitor transformations to each node.
+     *
+     * This function treats the API Definition as an AST. The purpose is to apply transformations to the "description" field of each node.
+     *
+     * @param api the API definition to visit
+     * @param visitor the visitor to apply to the API definition
+     * @returns the API definition with the visitor transformations applied
+     */
+    apiDefinition: (api: Latest.ApiDefinition) => Latest.ApiDefinition;
+    endpoint: (endpoint: Latest.EndpointDefinition, parentKey: string) => Latest.EndpointDefinition;
+    httpRequest: (request: Latest.HttpRequest, parentKey: string) => Latest.HttpRequest;
+    formDataField: (field: Latest.FormDataField, parentKey: string) => Latest.FormDataField;
+    httpResponse: (response: Latest.HttpResponse, parentKey: string) => Latest.HttpResponse;
+    objectType: <T extends Latest.ObjectType>(type: T, parentKey: string) => T;
+    errorResponse: (error: Latest.ErrorResponse, parentKey: string) => Latest.ErrorResponse;
+    exampleEndpointCall: (example: Latest.ExampleEndpointCall, parentKey: string) => Latest.ExampleEndpointCall;
+    webhookDefinition: (webhook: Latest.WebhookDefinition, parentKey: string) => Latest.WebhookDefinition;
+    webhookPayload: (payload: Latest.WebhookPayload, parentKey: string) => Latest.WebhookPayload;
+    webSocketChannel: (channel: Latest.WebSocketChannel, parentKey: string) => Latest.WebSocketChannel;
+    webSocketMessage: (message: Latest.WebSocketMessage, parentKey: string) => Latest.WebSocketMessage;
+    typeShape: (shape: Latest.TypeShape, parentKey: string) => Latest.TypeShape;
+    formDataRequest: (request: Latest.FormDataRequest, parentKey: string) => Latest.FormDataRequest;
+    typeDefinition: (type: Latest.TypeDefinition, parentKey: string) => Latest.TypeDefinition;
+}
+//# sourceMappingURL=transformer.d.ts.map

package/dist/api-definition/transformer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformer.d.ts","sourceRoot":"","sources":["../../src/api-definition/transformer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IAEjC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC,kBAAkB,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,kBAAkB,CAAC;IAChG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC;IAC1E,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC;IAC9E,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC;IAC9E,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,mBAAmB,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,mBAAmB,CAAC;IAClG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC;IAC1E,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC;IAG3E,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC;IAC5F,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC;IAGnF,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,gBAAgB,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC;IACzF,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,gBAAgB,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC;IACzF,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,uBAAuB,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,uBAAuB,CAAC;IAG9G,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC;IAChF,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC;IAClE,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC;IACxE,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC;IACpF,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC;IAClE,2BAA2B,CACvB,OAAO,EAAE,MAAM,CAAC,2BAA2B,EAC3C,GAAG,EAAE,MAAM,GACZ,MAAM,CAAC,2BAA2B,CAAC;IACtC,yBAAyB,CAAC,OAAO,EAAE,MAAM,CAAC,yBAAyB,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,yBAAyB,CAAC;IACpH,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,eAAe,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC;IACtF,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC;IAC9E,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC;IAC1E,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC;CACjF;AAED,qBAAa,WAAW;;WACN,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,WAAW;WA4BzD,YAAY,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,WAAW;IAgClG;;OAEG;WACW,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW;IAgC/D,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO;IAIP;;;;;;;;OAQG;IACH,aAAa,QAAS,MAAM,CAAC,aAAa,KAAG,MAAM,CAAC,aAAa,CAsC/D;IA0CF,QAAQ,aAAc,MAAM,CAAC,kBAAkB,aAAa,MAAM,KAAG,MAAM,CAAC,kBAAkB,CA+C5F;IAEF,WAAW,YAAa,MAAM,CAAC,WAAW,aAAa,MAAM,KAAG,MAAM,CAAC,WAAW,CAchF;IAEF,aAAa,UAAW,MAAM,CAAC,aAAa,aAAa,MAAM,KAAG,MAAM,CAAC,aAAa,CAepF;IAEF,YAAY,aAAc,MAAM,CAAC,YAAY,aAAa,MAAM,KAAG,MAAM,CAAC,YAAY,CAgBpF;IAEF,UAAU,GAAI,CAAC,SAAS,MAAM,CAAC,UAAU,QAAQ,CAAC,aAAa,MAAM,KAAG,CAAC,CAKvE;IAEF,aAAa,UAAW,MAAM,CAAC,aAAa,aAAa,MAAM,KAAG,MAAM,CAAC,aAAa,CASpF;IAEF,mBAAmB,YAAa,MAAM,CAAC,mBAAmB,aAAa,MAAM,KAAG,MAAM,CAAC,mBAAmB,CAkBxG;IAEF,iBAAiB,YAAa,MAAM,CAAC,iBAAiB,aAAa,MAAM,KAAG,MAAM,CAAC,iBAAiB,CAkBlG;IAEF,cAAc,YAAa,MAAM,CAAC,cAAc,aAAa,MAAM,KAAG,MAAM,CAAC,cAAc,CAGzF;IAEF,gBAAgB,YAAa,MAAM,CAAC,gBAAgB,aAAa,MAAM,KAAG,MAAM,CAAC,gBAAgB,CA8B/F;IAEF,gBAAgB,YAAa,MAAM,CAAC,gBAAgB,aAAa,MAAM,KAAG,MAAM,CAAC,gBAAgB,CAG/F;IAEF,SAAS,UAAW,MAAM,CAAC,SAAS,aAAa,MAAM,KAAG,MAAM,CAAC,SAAS,CA6BxE;IAEF,eAAe,YAAa,MAAM,CAAC,eAAe,aAAa,MAAM,KAAG,MAAM,CAAC,eAAe,CAK5F;IAEF,cAAc,SAAU,MAAM,CAAC,cAAc,aAAa,MAAM,KAAG,MAAM,CAAC,cAAc,CAKtF;CACL"}