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

package/dist/__test__/yes-version-yes-tabs.test.js

@@ -0,0 +1,27 @@
+import { FernNavigation } from "..";
+import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2";
+import { readFixture } from "./readFixtures";
+import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig";
+import { testGetNavigationRoot } from "./testGetNavigationRoot";
+const FIXTURE = "yes-version-yes-tabs";
+const slugs = [
+    "docs/api",
+    "docs/api/tab-1",
+    "docs/api/tab-2",
+    "docs/api/version-1/section-2",
+    "docs/api/version-1",
+    "docs/api/version-2",
+    "docs/api/version-2/tab-2",
+    "docs/api/version-2/tab-2/section-5"
+];
+// eslint-disable-next-line vitest/valid-title
+describe(FIXTURE, () => {
+    const fixture = readFixture(FIXTURE);
+    const v1 = FernNavigation.V1.toRootNode(fixture);
+    const latest = FernNavigationV1ToLatest.create().root(v1);
+    testGetAllUrlsFromDocsConfig(latest, fixture.baseUrl.domain);
+    slugs.forEach((slug) => {
+        testGetNavigationRoot(latest, slug);
+    });
+});
+//# sourceMappingURL=yes-version-yes-tabs.test.js.map

package/dist/__test__/yes-version-yes-tabs.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yes-version-yes-tabs.test.js","sourceRoot":"","sources":["../../src/__test__/yes-version-yes-tabs.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,MAAM,OAAO,GAAG,sBAAsB,CAAC;AACvC,MAAM,KAAK,GAAG;IACV,UAAU;IACV,gBAAgB;IAChB,gBAAgB;IAChB,8BAA8B;IAC9B,oBAAoB;IACpB,oBAAoB;IACpB,0BAA0B;IAC1B,oCAAoC;CACvC,CAAC;AAEF,8CAA8C;AAC9C,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACnB,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,EAAE,GAAG,cAAc,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,wBAAwB,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAE1D,4BAA4B,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACnB,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/api-definition/__test__/availability.test.d.ts

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

package/dist/api-definition/__test__/availability.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"availability.test.d.ts","sourceRoot":"","sources":["../../../src/api-definition/__test__/availability.test.ts"],"names":[],"mappings":""}

package/dist/api-definition/__test__/availability.test.js

@@ -0,0 +1,15 @@
+import { coalesceAvailability } from "../availability";
+import { Availability } from "../latest";
+describe("coalesceAvailability", () => {
+    it("should return the least stable availability level", () => {
+        expect(coalesceAvailability([Availability.Stable, Availability.Beta])).toBe(Availability.Beta);
+        expect(coalesceAvailability([Availability.Beta, Availability.Stable])).toBe(Availability.Beta);
+        expect(coalesceAvailability([Availability.Stable, Availability.Beta, Availability.Deprecated])).toBe(Availability.Deprecated);
+        expect(coalesceAvailability([Availability.Beta, Availability.InDevelopment])).toBe(Availability.InDevelopment);
+        expect(coalesceAvailability([Availability.PreRelease, Availability.InDevelopment])).toBe(Availability.InDevelopment);
+        expect(coalesceAvailability([Availability.GenerallyAvailable])).toBe(Availability.GenerallyAvailable);
+        expect(coalesceAvailability([Availability.Stable, Availability.Beta, Availability.Stable])).toBe(Availability.Beta);
+        expect(coalesceAvailability([])).toBeUndefined();
+    });
+});
+//# sourceMappingURL=availability.test.js.map

package/dist/api-definition/__test__/availability.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"availability.test.js","sourceRoot":"","sources":["../../../src/api-definition/__test__/availability.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QACzD,MAAM,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC/F,MAAM,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC/F,MAAM,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAChG,YAAY,CAAC,UAAU,CAC1B,CAAC;QACF,MAAM,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAC/G,MAAM,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CACpF,YAAY,CAAC,aAAa,CAC7B,CAAC;QACF,MAAM,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QACtG,MAAM,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAC5F,YAAY,CAAC,IAAI,CACpB,CAAC;QACF,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/api-definition/__test__/join.test.d.ts

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

package/dist/api-definition/__test__/join.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"join.test.d.ts","sourceRoot":"","sources":["../../../src/api-definition/__test__/join.test.ts"],"names":[],"mappings":""}

package/dist/api-definition/__test__/join.test.js

@@ -0,0 +1,319 @@
+import { APIV1Read } from "../../client";
+import { joiner } from "../join";
+import * as Latest from "../latest";
+const PRIMITIVE_SHAPE = {
+    type: "primitive",
+    value: {
+        type: "string",
+        format: undefined,
+        regex: undefined,
+        minLength: undefined,
+        maxLength: undefined,
+        default: undefined
+    }
+};
+const endpoint1 = {
+    id: Latest.EndpointId("endpoint-1"),
+    namespace: [],
+    displayName: "endpoint-1",
+    operationId: "endpoint-1",
+    protocol: undefined,
+    method: "GET",
+    path: [],
+    defaultEnvironment: Latest.EnvironmentId("production"),
+    environments: [
+        {
+            id: Latest.EnvironmentId("production"),
+            baseUrl: "https://example.com"
+        }
+    ],
+    pathParameters: undefined,
+    queryParameters: [
+        {
+            key: Latest.PropertyKey("query"),
+            valueShape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: Latest.TypeId("type-1"),
+                    default: undefined
+                }
+            },
+            description: undefined,
+            availability: undefined,
+            propertyAccess: undefined,
+            explode: undefined
+        }
+    ],
+    requestHeaders: undefined,
+    responseHeaders: undefined,
+    requests: undefined,
+    responses: undefined,
+    auth: undefined,
+    multiAuth: undefined,
+    description: undefined,
+    availability: undefined,
+    errors: undefined,
+    examples: undefined,
+    snippetTemplates: undefined,
+    includeInApiExplorer: undefined
+};
+const endpoint2 = {
+    id: Latest.EndpointId("endpoint-2"),
+    namespace: [],
+    displayName: "endpoint-2",
+    operationId: "endpoint-2",
+    protocol: undefined,
+    method: "GET",
+    path: [],
+    defaultEnvironment: Latest.EnvironmentId("production"),
+    environments: [
+        {
+            id: Latest.EnvironmentId("production"),
+            baseUrl: "https://example.com"
+        }
+    ],
+    pathParameters: undefined,
+    queryParameters: undefined,
+    requestHeaders: [
+        {
+            key: Latest.PropertyKey("header"),
+            valueShape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: Latest.TypeId("type-2"),
+                    default: undefined
+                }
+            },
+            description: undefined,
+            availability: undefined,
+            propertyAccess: undefined
+        }
+    ],
+    responseHeaders: undefined,
+    requests: undefined,
+    responses: undefined,
+    auth: [Latest.AuthSchemeId("auth")],
+    multiAuth: undefined,
+    description: undefined,
+    availability: undefined,
+    errors: undefined,
+    examples: undefined,
+    snippetTemplates: undefined,
+    includeInApiExplorer: undefined
+};
+const websocket1 = {
+    id: Latest.WebSocketId("websocket-1"),
+    namespace: [],
+    path: [],
+    displayName: "websocket-1",
+    operationId: "websocket-1",
+    messages: [
+        {
+            type: APIV1Read.WebSocketMessageId("message-1"),
+            description: undefined,
+            availability: undefined,
+            displayName: undefined,
+            origin: "client",
+            body: {
+                type: "alias",
+                value: {
+                    type: "optional",
+                    default: undefined,
+                    shape: {
+                        type: "alias",
+                        value: {
+                            type: "id",
+                            id: Latest.TypeId("type-3"),
+                            default: undefined
+                        }
+                    }
+                }
+            }
+        }
+    ],
+    defaultEnvironment: Latest.EnvironmentId("production"),
+    environments: [
+        {
+            id: Latest.EnvironmentId("production"),
+            baseUrl: "https://example.com"
+        }
+    ],
+    pathParameters: undefined,
+    queryParameters: undefined,
+    requestHeaders: undefined,
+    auth: undefined,
+    description: undefined,
+    availability: undefined,
+    examples: undefined
+};
+const type1 = {
+    name: "type-1",
+    description: undefined,
+    availability: undefined,
+    shape: {
+        type: "alias",
+        value: PRIMITIVE_SHAPE
+    },
+    displayName: undefined
+};
+const type2 = {
+    name: "type-2",
+    description: undefined,
+    availability: undefined,
+    shape: {
+        type: "alias",
+        value: PRIMITIVE_SHAPE
+    },
+    displayName: undefined
+};
+const type3 = {
+    name: "type-3",
+    description: undefined,
+    availability: undefined,
+    shape: {
+        type: "alias",
+        value: PRIMITIVE_SHAPE
+    },
+    displayName: undefined
+};
+const type4 = {
+    name: "type-4",
+    description: undefined,
+    availability: undefined,
+    shape: {
+        type: "alias",
+        value: PRIMITIVE_SHAPE
+    },
+    displayName: undefined
+};
+const authScheme = {
+    type: "bearerAuth",
+    tokenName: "API Token",
+    description: undefined
+};
+const api1 = {
+    id: Latest.ApiDefinitionId("api"),
+    apiName: undefined,
+    endpoints: {
+        [endpoint1.id]: endpoint1
+    },
+    webhooks: {},
+    websockets: {},
+    types: {
+        [Latest.TypeId("type-1")]: type1,
+        [Latest.TypeId("type-4")]: type4
+    },
+    subpackages: {},
+    auths: {},
+    globalHeaders: [
+        {
+            key: Latest.PropertyKey("global"),
+            valueShape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: Latest.TypeId("type-4"),
+                    default: undefined
+                }
+            },
+            description: undefined,
+            availability: undefined,
+            propertyAccess: undefined
+        }
+    ],
+    snippetsConfiguration: undefined
+};
+const api2 = {
+    id: Latest.ApiDefinitionId("api"),
+    apiName: undefined,
+    endpoints: {
+        [endpoint2.id]: endpoint2
+    },
+    webhooks: {},
+    websockets: {},
+    types: {
+        [Latest.TypeId("type-2")]: type2,
+        [Latest.TypeId("type-4")]: type4
+    },
+    subpackages: {},
+    auths: {
+        [Latest.AuthSchemeId("auth")]: authScheme
+    },
+    globalHeaders: [
+        {
+            key: Latest.PropertyKey("global"),
+            valueShape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: Latest.TypeId("type-4"),
+                    default: undefined
+                }
+            },
+            description: undefined,
+            availability: undefined,
+            propertyAccess: undefined
+        }
+    ],
+    snippetsConfiguration: undefined
+};
+const api3 = {
+    id: Latest.ApiDefinitionId("api"),
+    apiName: undefined,
+    endpoints: {},
+    webhooks: {},
+    websockets: {
+        [websocket1.id]: websocket1
+    },
+    types: {
+        [Latest.TypeId("type-3")]: type3,
+        [Latest.TypeId("type-4")]: type4
+    },
+    subpackages: {},
+    auths: {},
+    globalHeaders: [
+        {
+            key: Latest.PropertyKey("global"),
+            valueShape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: Latest.TypeId("type-4"),
+                    default: undefined
+                }
+            },
+            description: undefined,
+            availability: undefined,
+            propertyAccess: undefined
+        }
+    ],
+    snippetsConfiguration: undefined
+};
+describe("join", () => {
+    it("should prune endpoint1 and its types", () => {
+        const pruned = joiner()(api1, api2, api3);
+        expect(Object.keys(pruned.endpoints)).toStrictEqual([endpoint1.id, endpoint2.id]);
+        expect(Object.keys(pruned.websockets)).toStrictEqual([websocket1.id]);
+        expect(new Set(Object.keys(pruned.types))).toStrictEqual(new Set([type1.name, type2.name, type3.name, type4.name]));
+        expect(Object.keys(pruned.auths)).toStrictEqual([Latest.AuthSchemeId("auth")]);
+        expect(pruned.globalHeaders).toStrictEqual([
+            {
+                key: Latest.PropertyKey("global"),
+                valueShape: {
+                    type: "alias",
+                    value: {
+                        type: "id",
+                        id: Latest.TypeId("type-4"),
+                        default: undefined
+                    }
+                },
+                description: undefined,
+                availability: undefined,
+                propertyAccess: undefined
+            }
+        ]);
+    });
+});
+//# sourceMappingURL=join.test.js.map

package/dist/api-definition/__test__/join.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"join.test.js","sourceRoot":"","sources":["../../../src/api-definition/__test__/join.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,MAAM,eAAe,GAAmC;IACpD,IAAI,EAAE,WAAoB;IAC1B,KAAK,EAAE;QACH,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,SAAS;QACjB,KAAK,EAAE,SAAS;QAChB,SAAS,EAAE,SAAS;QACpB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,SAAS;KACrB;CACJ,CAAC;AAEF,MAAM,SAAS,GAA8B;IACzC,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC;IACnC,SAAS,EAAE,EAAE;IACb,WAAW,EAAE,YAAY;IACzB,WAAW,EAAE,YAAY;IACzB,QAAQ,EAAE,SAAS;IACnB,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,EAAE;IACR,kBAAkB,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;IACtD,YAAY,EAAE;QACV;YACI,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;YACtC,OAAO,EAAE,qBAAqB;SACjC;KACJ;IACD,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE;QACb;YACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC;YAChC,UAAU,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3B,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,SAAS;YACzB,OAAO,EAAE,SAAS;SACrB;KACJ;IACD,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE,SAAS;IAC1B,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,SAAS;IACpB,IAAI,EAAE,SAAS;IACf,SAAS,EAAE,SAAS;IACpB,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,MAAM,EAAE,SAAS;IACjB,QAAQ,EAAE,SAAS;IACnB,gBAAgB,EAAE,SAAS;IAC3B,oBAAoB,EAAE,SAAS;CAClC,CAAC;AAEF,MAAM,SAAS,GAA8B;IACzC,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC;IACnC,SAAS,EAAE,EAAE;IACb,WAAW,EAAE,YAAY;IACzB,WAAW,EAAE,YAAY;IACzB,QAAQ,EAAE,SAAS;IACnB,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,EAAE;IACR,kBAAkB,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;IACtD,YAAY,EAAE;QACV;YACI,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;YACtC,OAAO,EAAE,qBAAqB;SACjC;KACJ;IACD,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE,SAAS;IAC1B,cAAc,EAAE;QACZ;YACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;YACjC,UAAU,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3B,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,SAAS;SAC5B;KACJ;IACD,eAAe,EAAE,SAAS;IAC1B,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,SAAS;IACpB,IAAI,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACnC,SAAS,EAAE,SAAS;IACpB,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,MAAM,EAAE,SAAS;IACjB,QAAQ,EAAE,SAAS;IACnB,gBAAgB,EAAE,SAAS;IAC3B,oBAAoB,EAAE,SAAS;CAClC,CAAC;AAEF,MAAM,UAAU,GAA4B;IACxC,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC;IACrC,SAAS,EAAE,EAAE;IACb,IAAI,EAAE,EAAE;IACR,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE;QACN;YACI,IAAI,EAAE,SAAS,CAAC,kBAAkB,CAAC,WAAW,CAAC;YAC/C,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,WAAW,EAAE,SAAS;YACtB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE;gBACF,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,UAAU;oBAChB,OAAO,EAAE,SAAS;oBAClB,KAAK,EAAE;wBACH,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACH,IAAI,EAAE,IAAI;4BACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;4BAC3B,OAAO,EAAE,SAAS;yBACrB;qBACJ;iBACJ;aACJ;SACJ;KACJ;IACD,kBAAkB,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;IACtD,YAAY,EAAE;QACV;YACI,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;YACtC,OAAO,EAAE,qBAAqB;SACjC;KACJ;IACD,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE,SAAS;IAC1B,cAAc,EAAE,SAAS;IACzB,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,QAAQ,EAAE,SAAS;CACtB,CAAC;AAEF,MAAM,KAAK,GAA0B;IACjC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;KACzB;IACD,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,KAAK,GAA0B;IACjC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;KACzB;IACD,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,KAAK,GAA0B;IACjC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;KACzB;IACD,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,KAAK,GAA0B;IACjC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;KACzB;IACD,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,UAAU,GAAsB;IAClC,IAAI,EAAE,YAAY;IAClB,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,IAAI,GAAyB;IAC/B,EAAE,EAAE,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC;IACjC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE;QACP,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS;KAC5B;IACD,QAAQ,EAAE,EAAE;IACZ,UAAU,EAAE,EAAE;IACd,KAAK,EAAE;QACH,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;QAChC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;KACnC;IACD,WAAW,EAAE,EAAE;IACf,KAAK,EAAE,EAAE;IACT,aAAa,EAAE;QACX;YACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;YACjC,UAAU,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3B,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,SAAS;SAC5B;KACJ;IACD,qBAAqB,EAAE,SAAS;CACnC,CAAC;AAEF,MAAM,IAAI,GAAyB;IAC/B,EAAE,EAAE,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC;IACjC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE;QACP,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS;KAC5B;IACD,QAAQ,EAAE,EAAE;IACZ,UAAU,EAAE,EAAE;IACd,KAAK,EAAE;QACH,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;QAChC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;KACnC;IACD,WAAW,EAAE,EAAE;IACf,KAAK,EAAE;QACH,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU;KAC5C;IACD,aAAa,EAAE;QACX;YACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;YACjC,UAAU,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3B,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,SAAS;SAC5B;KACJ;IACD,qBAAqB,EAAE,SAAS;CACnC,CAAC;AAEF,MAAM,IAAI,GAAyB;IAC/B,EAAE,EAAE,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC;IACjC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,UAAU,EAAE;QACR,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,UAAU;KAC9B;IACD,KAAK,EAAE;QACH,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;QAChC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;KACnC;IACD,WAAW,EAAE,EAAE;IACf,KAAK,EAAE,EAAE;IACT,aAAa,EAAE;QACX;YACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;YACjC,UAAU,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3B,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,SAAS;SAC5B;KACJ;IACD,qBAAqB,EAAE,SAAS;CACnC,CAAC;AAEF,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IAClB,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAE1C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAClF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CACpD,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAC5D,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC/E,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC;YACvC;gBACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;gBACjC,UAAU,EAAE;oBACR,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,IAAI;wBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;wBAC3B,OAAO,EAAE,SAAS;qBACrB;iBACJ;gBACD,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,cAAc,EAAE,SAAS;aAC5B;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/api-definition/__test__/prune.test.d.ts

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

package/dist/api-definition/__test__/prune.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prune.test.d.ts","sourceRoot":"","sources":["../../../src/api-definition/__test__/prune.test.ts"],"names":[],"mappings":""}

package/dist/api-definition/__test__/prune.test.js

@@ -0,0 +1,267 @@
+import { APIV1Read } from "../../client";
+import * as Latest from "../latest";
+import { prune } from "../prune";
+const PRIMITIVE_SHAPE = {
+    type: "primitive",
+    value: {
+        type: "string",
+        format: undefined,
+        regex: undefined,
+        minLength: undefined,
+        maxLength: undefined,
+        default: undefined
+    }
+};
+const endpoint1 = {
+    id: Latest.EndpointId("endpoint-1"),
+    displayName: "endpoint-1",
+    operationId: "endpoint-1",
+    protocol: undefined,
+    namespace: [],
+    method: "GET",
+    path: [],
+    defaultEnvironment: Latest.EnvironmentId("production"),
+    environments: [
+        {
+            id: Latest.EnvironmentId("production"),
+            baseUrl: "https://example.com"
+        }
+    ],
+    pathParameters: undefined,
+    queryParameters: [
+        {
+            key: Latest.PropertyKey("query"),
+            valueShape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: Latest.TypeId("type-1"),
+                    default: undefined
+                }
+            },
+            description: undefined,
+            availability: undefined,
+            propertyAccess: undefined,
+            explode: undefined
+        }
+    ],
+    requestHeaders: undefined,
+    responseHeaders: undefined,
+    requests: undefined,
+    responses: undefined,
+    auth: undefined,
+    multiAuth: undefined,
+    description: undefined,
+    availability: undefined,
+    errors: undefined,
+    examples: undefined,
+    snippetTemplates: undefined,
+    includeInApiExplorer: undefined
+};
+const endpoint2 = {
+    id: Latest.EndpointId("endpoint-2"),
+    displayName: "endpoint-2",
+    operationId: "endpoint-2",
+    protocol: undefined,
+    namespace: [],
+    method: "GET",
+    path: [],
+    defaultEnvironment: Latest.EnvironmentId("production"),
+    environments: [
+        {
+            id: Latest.EnvironmentId("production"),
+            baseUrl: "https://example.com"
+        }
+    ],
+    pathParameters: undefined,
+    queryParameters: undefined,
+    requestHeaders: [
+        {
+            key: Latest.PropertyKey("header"),
+            valueShape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: Latest.TypeId("type-2"),
+                    default: undefined
+                }
+            },
+            description: undefined,
+            availability: undefined,
+            propertyAccess: undefined
+        }
+    ],
+    responseHeaders: undefined,
+    requests: undefined,
+    responses: undefined,
+    auth: [Latest.AuthSchemeId("auth")],
+    multiAuth: undefined,
+    description: undefined,
+    availability: undefined,
+    errors: undefined,
+    examples: undefined,
+    snippetTemplates: undefined,
+    includeInApiExplorer: undefined
+};
+const websocket1 = {
+    id: Latest.WebSocketId("websocket-1"),
+    displayName: "websocket-1",
+    operationId: "websocket-1",
+    namespace: [],
+    path: [],
+    messages: [
+        {
+            type: APIV1Read.WebSocketMessageId("message-1"),
+            description: undefined,
+            availability: undefined,
+            displayName: undefined,
+            origin: "client",
+            body: {
+                type: "alias",
+                value: {
+                    type: "optional",
+                    default: undefined,
+                    shape: {
+                        type: "alias",
+                        value: {
+                            type: "id",
+                            id: Latest.TypeId("type-3"),
+                            default: undefined
+                        }
+                    }
+                }
+            }
+        }
+    ],
+    defaultEnvironment: Latest.EnvironmentId("production"),
+    environments: [
+        {
+            id: Latest.EnvironmentId("production"),
+            baseUrl: "https://example.com"
+        }
+    ],
+    pathParameters: undefined,
+    queryParameters: undefined,
+    requestHeaders: undefined,
+    auth: undefined,
+    description: undefined,
+    availability: undefined,
+    examples: undefined
+};
+const type1 = {
+    name: "type-1",
+    description: undefined,
+    availability: undefined,
+    shape: {
+        type: "alias",
+        value: PRIMITIVE_SHAPE
+    },
+    displayName: undefined
+};
+const type2 = {
+    name: "type-2",
+    description: undefined,
+    availability: undefined,
+    shape: {
+        type: "alias",
+        value: PRIMITIVE_SHAPE
+    },
+    displayName: undefined
+};
+const type3 = {
+    name: "type-3",
+    description: undefined,
+    availability: undefined,
+    shape: {
+        type: "alias",
+        value: PRIMITIVE_SHAPE
+    },
+    displayName: undefined
+};
+const type4 = {
+    name: "type-4",
+    description: undefined,
+    availability: undefined,
+    shape: {
+        type: "alias",
+        value: PRIMITIVE_SHAPE
+    },
+    displayName: undefined
+};
+const authScheme = {
+    type: "bearerAuth",
+    tokenName: "API Token",
+    description: undefined
+};
+const api = {
+    id: Latest.ApiDefinitionId("api"),
+    apiName: undefined,
+    endpoints: {
+        [endpoint1.id]: endpoint1,
+        [endpoint2.id]: endpoint2
+    },
+    webhooks: {},
+    websockets: {
+        [websocket1.id]: websocket1
+    },
+    types: {
+        [Latest.TypeId("type-1")]: type1,
+        [Latest.TypeId("type-2")]: type2,
+        [Latest.TypeId("type-3")]: type3,
+        [Latest.TypeId("type-4")]: type4
+    },
+    subpackages: {},
+    auths: {
+        [Latest.AuthSchemeId("auth")]: authScheme
+    },
+    globalHeaders: [
+        {
+            key: Latest.PropertyKey("global"),
+            valueShape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: Latest.TypeId("type-4"),
+                    default: undefined
+                }
+            },
+            description: undefined,
+            availability: undefined,
+            propertyAccess: undefined
+        }
+    ],
+    snippetsConfiguration: undefined
+};
+describe("prune", () => {
+    it("should prune endpoint1 and its types", () => {
+        const pruned = prune(api, {
+            type: "endpoint",
+            endpointId: endpoint1.id
+        });
+        expect(Object.keys(pruned.endpoints)).toStrictEqual([endpoint1.id]);
+        expect(Object.keys(pruned.websockets)).toStrictEqual([]);
+        expect(Object.keys(pruned.types)).toStrictEqual([type1.name, type4.name]);
+        expect(Object.keys(pruned.auths)).toStrictEqual([]);
+    });
+    it("should prune endpoint2 and its types", () => {
+        const pruned = prune(api, {
+            type: "endpoint",
+            endpointId: endpoint2.id
+        });
+        expect(Object.keys(pruned.endpoints)).toStrictEqual([endpoint2.id]);
+        expect(Object.keys(pruned.websockets)).toStrictEqual([]);
+        expect(Object.keys(pruned.types)).toStrictEqual([type2.name, type4.name]);
+        expect(Object.keys(pruned.auths)).toStrictEqual(["auth"]);
+    });
+    it("should prune websocket1 and its types", () => {
+        const pruned = prune(api, {
+            type: "webSocket",
+            webSocketId: websocket1.id
+        });
+        expect(Object.keys(pruned.endpoints)).toStrictEqual([]);
+        expect(Object.keys(pruned.websockets)).toStrictEqual([websocket1.id]);
+        expect(Object.keys(pruned.types)).toStrictEqual([type3.name, type4.name]);
+        expect(Object.keys(pruned.auths)).toStrictEqual([]);
+    });
+});
+//# sourceMappingURL=prune.test.js.map